feat: Add docstrings to generated Python APIs - #593
Closed
razor-x wants to merge 3 commits into
Closed
Conversation
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.
Motivation
Description
codegen/lib/class-model.ts,codegen/lib/routes.ts) and build method/resource docstrings (codegen/lib/layouts/route.ts,codegen/lib/layouts/resources.ts).:param/:type/:returns/:vartype/:ivarand.. deprecated::directives (changes tocodegen/layouts/partials/*.hbsandcodegen/layouts/route.hbs).:ivardocs for all properties.seam/routesandseam/resourcesto include the new docstrings and deprecation annotations across the SDK surface.Testing
npm run typecheck(passed).npm run lintandnpm run format(passed); code style fixes applied where necessary.npm run generate(generation completed; the run emitted a small set of blueprint warnings about undocumented types but successfully produced regenerated modules).PYENV_VERSION=3.12.13 make formatandPYENV_VERSION=3.12.13 python -m compileall -q seam(format/compile run in the environment with3.12.13succeeded);git diff --checkreturned clean.PYENV_VERSION=3.12.13 poetry run pytest -qbut tests could not run because the environment could not downloadurllib3from PyPI (network / package fetch blocked); thus test suite is blocked on dependency fetch and not fully exercised here.Codex Task