CG-10630: Doc Generation Upgrade #259
Merged
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
…m class docstrings, added missing page
EdwardJXLi
approved these changes
Feb 3, 2025
jayhack
pushed a commit
that referenced
this pull request
Feb 9, 2025
# Motivation
- Attribute section should not show up in class docstrings
- Fixed Incorrect parameter and return types in language specific
symbols
- PySymbol.file now shows `PyFile` type (instead of `SourceFile`)
- Added missing page for ImportType
# Content
- added code that removes attributes section from class docstrings
- modified logic to properly resolve parameter and return types in
language specific symbols
- added docstring for ImportType
# Testing
existing test were used.
# Please check the following before marking your PR as ready for review
- [x] I have added tests for my changes
- [x] I have updated the documentation or added new documentation as
needed
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
PyFiletype (instead ofSourceFile)Content
Testing
existing test were used.
Please check the following before marking your PR as ready for review