-
Notifications
You must be signed in to change notification settings - Fork 416
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Doc/warning improvements #2415
Merged
Merged
Doc/warning improvements #2415
Conversation
This file contains 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
This replaces telling it to document imported names.
This fixes the oddity where only metpy.io was listed in full, while the others showed the trailing module name. Instead, provide a descriptive name along with teh full module name.
This is one of a few steps it would take to get module-level attributes (e.g. instances) listed in the generated docs. Unfortunately, while sphinx can parse files and grab assignments that have doc-comments with them ('#:'), we have problems because we're pulling instances out of sub-modules.
lcl actually works just fine on grids.
This make the message appropriate to whether we were given a MaskedArray or not.
dopplershift
added
Type: Bug
Something is not working like it should
Area: Docs
Affects documentation
Type: Enhancement
Enhancement to existing functionality
Area: Units
Pertains to unit information
labels
Apr 6, 2022
dcamron
approved these changes
Apr 6, 2022
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like these changes, and final product seems to come together consistently on my machine and on actions.
jthielen
approved these changes
Apr 6, 2022
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
Area: Docs
Affects documentation
Area: Units
Pertains to unit information
Type: Bug
Something is not working like it should
Type: Enhancement
Enhancement to existing functionality
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
lcl
doc (lcl
works on n-dimensional arrays #2313)__all__
as the definitive source for what to includecheck_unit
error message #2334)With the last one:
gives:
whereas with a numpy array it gives:
Checklist
check_unit
error message #2334lcl
works on n-dimensional arrays #2313