Skip to content

chore(types): regenerate with spec descriptions in docstrings - #175

Open
hey-august wants to merge 1 commit into
mainfrom
august-20260924-730-generated-docstrings
Open

hey-august wants to merge 1 commit into
mainfrom
august-20260924-730-generated-docstrings

Conversation

@hey-august

Copy link
Copy Markdown
Contributor

What this changes

Regenerates the 35 *_generated.py modules with the docstrings the porting-sdk generator now emits from the specs (signalwire/porting-sdk#149). Every TypedDict gets a description and an Attributes: section, every resource method gets a summary, Args: and Returns:. Resource method docstring coverage in rest goes from 0 of 180 to 180 of 180. No code changes: stripping the docstrings leaves the files identical to main.

Coordinated-With: porting-sdk@august-20261009-spec-descs-to-py-docstrings

Part of signalwire/docs#724. Closes signalwire/docs#730 with the porting-sdk half.

Testing

  • Generator --check passes against these files; two regenerations produce an identical diff.
  • ruff check, ruff format, mypy strict clean. pydoclint clean. ruff D: 49 findings, all D107.
  • 990 unit tests covering the generated modules pass.

Checklist

Check off each item:

  • bash scripts/run-ci.sh passes locally
  • New tests assert on content (not only "does not raise" / "is not None") n/a, no new tests
  • New test functions are type-annotated (mypy covers tests/) n/a, no new tests

Does this change public API?

Check one:

  • No
  • Yes: naming it here so a maintainer can land the matching
    infrastructure change:

Changing something that goes on the wire?

No. Docstrings only.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Python Server SDK: emit OpenAPI and schema descriptions into generated docstrings (porting-sdk generator)

1 participant