Migrate traitlets documentation from __doc__ to help#3983
Open
tensor-calculus wants to merge 4 commits intoUnidata:mainfrom
Open
Migrate traitlets documentation from __doc__ to help#3983tensor-calculus wants to merge 4 commits intoUnidata:mainfrom
tensor-calculus wants to merge 4 commits intoUnidata:mainfrom
Conversation
Author
|
There seem to be a number of linting errors related to pre-existing docstrings in this file, which were present prior to this PR and were not modified as part of my changes. Since these docstrings are user-facing and feed directly into the rendered documentation, I’m a bit hesitant to alter them solely to satisfy linting. I’m not entirely sure how to proceed here; if there’s an established ignore or exception mechanism for this situation, please let me know. |
dcamron
reviewed
Jan 7, 2026
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.
Description Of Changes
pyproject.toml
5.8.0from5.1.0.plots/declarative.py
traitlets.__doc__and instead defined them using thehelpparameter.?,help(), and<TAB>completion, all of which worked as intended.PS: This is my first contribution to MetPy. If there is anything specific you’d like me to adjust in this PR or any other areas you think would be helpful for me to work on, I’d be happy to do so.
Checklist
helpparameter for traits rather than setting __doc__ #2844