[PR #28] [MERGED] docs: document the public methods that had no docstrings #35

New issue

Closed

opened 2026-10-31 22:00:56 +00:00 by bsakaguchi · 0 comments

bsakaguchi commented

2026-10-31 22:00:56 +00:00

Owner

📋 Pull Request Information

Original PR: https://github.com/Comfy-Org/comfy-python-sdk/pull/28
Author: @robinjhuang
Created: 7/30/2026
Status: ✅ Merged
Merged: 7/30/2026
Merged by: @robinjhuang

Base: main ← Head: docs/public-api-docstrings

📝 Commits (1)

7bb7888 docs: document the public methods that had no docstrings

📊 Changes

4 files changed (+65 additions, -0 deletions)

View changed files

📝 src/comfy_sdk/client.py (+8 -0)
📝 src/comfy_sdk/jobs.py (+27 -0)
📝 src/comfy_sdk/outputs.py (+20 -0)
📝 src/comfy_sdk/workflows.py (+10 -0)

📄 Description

Runtime introspection is how most people and most tooling explore an installed SDK, and the gaps were in the least guessable places: the range= tuple on Output.to_file/to_stream/to_bytes is an inclusive HTTP byte range, Job.get_outputs reads cached state rather than re-fetching, and cancel() is a request rather than a guarantee. Workflow had no class docstring at all, so nothing pointed at the API-format-vs-UI-format split.

Async variants defer to their sync counterpart, matching the existing convention. Public-method docstring coverage goes from 15/28 to 28/28; no behaviour change.

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/Comfy-Org/comfy-python-sdk/pull/28 **Author:** [@robinjhuang](https://github.com/robinjhuang) **Created:** 7/30/2026 **Status:** ✅ Merged **Merged:** 7/30/2026 **Merged by:** [@robinjhuang](https://github.com/robinjhuang) **Base:** `main` ← **Head:** `docs/public-api-docstrings` --- ### 📝 Commits (1) - [`7bb7888`](https://github.com/Comfy-Org/comfy-python-sdk/commit/7bb7888f228567e32cc16a1a8c92514c9993a944) docs: document the public methods that had no docstrings ### 📊 Changes **4 files changed** (+65 additions, -0 deletions) <details> <summary>View changed files</summary> 📝 `src/comfy_sdk/client.py` (+8 -0) 📝 `src/comfy_sdk/jobs.py` (+27 -0) 📝 `src/comfy_sdk/outputs.py` (+20 -0) 📝 `src/comfy_sdk/workflows.py` (+10 -0) </details> ### 📄 Description Runtime introspection is how most people and most tooling explore an installed SDK, and the gaps were in the least guessable places: the `range=` tuple on `Output.to_file`/`to_stream`/`to_bytes` is an *inclusive* HTTP byte range, `Job.get_outputs` reads cached state rather than re-fetching, and `cancel()` is a request rather than a guarantee. `Workflow` had no class docstring at all, so nothing pointed at the API-format-vs-UI-format split. Async variants defer to their sync counterpart, matching the existing convention. Public-method docstring coverage goes from 15/28 to 28/28; no behaviour change. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

bsakaguchi

2026-10-31 22:00:56 +00:00