docs: Add docstrings for attributes [skip tests] #3980
Draft
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
Collaborator
hpohekar
commented
Apr 29, 2025
•
hpohekar
commented
github-actions
bot
added
the
documentation
hpohekar
commented
Apr 29, 2025
Comment on lines
+100
to
+102
| #: This is a class attribute with a docstring. | ||
| my_attr = 42 | ||
|
|
There was a problem hiding this comment.
@ansys/pyfluent-maintainers This is how we can add a class attribute docstring.
hpohekar
commented
Apr 29, 2025
Comment on lines
+137
to
+138
| #: This is an instance attribute with a docstring. | ||
| self.monitor = None |
There was a problem hiding this comment.
@ansys/pyfluent-maintainers This is how we can add an instance attribute docstring.
It will be rendered as follows:
mkundu1
added a commit
that referenced
this pull request
Apr 30, 2025
Based on #3980's findings. The script is mostly generated by AI. Please see the module doc on how to run the script. There are around 400-450 undocumented attributes. We'll plan how to divide the workload to add the missing attribute docs. --------- Co-authored-by: pyansys-ci-bot <[email protected]>
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.