first pass at better docs for declarative #1046
Merged
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
dopplershift
added
Area: Docs
dopplershift
requested changes
Jun 6, 2019
metpy/plots/declarative.py
Outdated
| object. | ||
|
|
||
| There are three pre-defined projections that can be called with a short name: | ||
| Lambert Conformal ('lcc'), Mercator ('mer'), or polar-stereographic ('ps'). Additionally, |
There was a problem hiding this comment.
Should "Conformal" be "conformal"?
There was a problem hiding this comment.
I've seen it both ways...we'll go lower case hear and I added "conic" to make it a more inline with using "lcc"
There was a problem hiding this comment.
I'm ok with leaving it capital if polar stereographic is also capitalized.
|
I also found two traits that I missed! I've added short descriptions for |
|
Merging over the skewT test failures on Travis. |
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.
This is a work in progress that partially addresses #1016 with improved documentation for the declarative syntax. Feedback welcome from all.
One question: there are a number of attributes that are listed in the online documentation that can't actually be set by the user, is there a way to not include those? I have left those attributes with the default language. Some examples of these attributes are: cross_validatation_lock, griddata, name, parent, and plotdata.