CG-10472: Adds docstrings to class attributes missing docstrings #236
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
|
codegen-bot seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account. You have signed the CLA already but the status is still pending? Let us recheck it. |
Codecov ReportAttention: Patch coverage is ✅ All tests successful. No failed tests found.
Additional details and impacted files |
jemeza-codegen
changed the title
bagel897
suggested changes
Jan 31, 2025
| """Range within the codebase | ||
| Attributes: | ||
| model_config: Configuration for the model, including JSON encoders. |
| var z | ||
| var z = 5 | ||
| ``` | ||
| _left: The internal representation of the left side of the assignment as an Expression. |
Contributor
There was a problem hiding this comment.
Don't include private attributes
| Attributes: | ||
| symbol_type: The type of symbol, set to SymbolType.Class. | ||
| constructor_keyword: The keyword used to identify the constructor method. |
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
Many attributes have missing docstrings
Content
Adds missing docstrings to attributes of classes decorated with one of
apidoc,py_apidocorts_apidoc.Please check the following before marking your PR as ready for review