Repository navigation
chore(types): regenerate with spec descriptions in docstrings - #175
Open
hey-august wants to merge 1 commit into
Open
hey-august wants to merge 1 commit into
hey-august wants to merge 1 commit into
Conversation
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What this changes
Regenerates the 35
*_generated.pymodules with the docstrings the porting-sdk generator now emits from the specs (signalwire/porting-sdk#149). Every TypedDict gets a description and anAttributes:section, every resource method gets a summary,Args:andReturns:. Resource method docstring coverage inrestgoes 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
--checkpasses against these files; two regenerations produce an identical diff.D: 49 findings, all D107.Checklist
Check off each item:
bash scripts/run-ci.shpasses locallymypycoverstests/) n/a, no new testsDoes this change public API?
Check one:
infrastructure change:
Changing something that goes on the wire?
No. Docstrings only.