Doc tweaks #326
Merged
Doc tweaks #326
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
|
Not the most elegant, but it does get the class methods documented. Thoughts @dopplershift? |
|
I think we can safely ignore codecov here since it's griping about the references? |
|
Can you rebase and push? I'm concerned about the drop in coverage in the tests themselves. |
dopplershift
requested changes
Mar 22, 2017
metpy/calc/basic.py
Outdated
| @@ -242,7 +224,7 @@ def heat_index(temperature, rh, mask_undefined=True): | |||
| def pressure_to_height_std(pressure): | |||
| r"""Convert pressure data to heights using the U.S. standard atmosphere. | |||
|
|
|||
| The implementation uses the formula outlined in [7]_. | |||
| The implementation uses the formula outlined in [Hobbs1977]_. | |||
There was a problem hiding this comment.
Can you add the pages here?
metpy/calc/basic.py
Outdated
| @@ -273,7 +250,7 @@ def pressure_to_height_std(pressure): | |||
| def coriolis_parameter(latitude): | |||
| r"""Calculate the coriolis parameter at each point. | |||
|
|
|||
| The implementation uses the formula outlined in [8]_. | |||
| The implementation uses the formula outlined in [Hobbs1977]_. | |||
metpy/calc/thermo.py
Outdated
| @@ -339,15 +334,10 @@ def vapor_pressure(pressure, mixing): | |||
| Notes | |||
| ----- | |||
| This function is a straightforward implementation of the equation given in many places, | |||
| such as [2]_: | |||
| such as [Hobbs1977]_: | |||
metpy/calc/thermo.py
Outdated
| @@ -478,15 +460,10 @@ def mixing_ratio(part_press, tot_press, molecular_weight_ratio=epsilon): | |||
| Notes | |||
| ----- | |||
| This function is a straightforward implementation of the equation given in many places, | |||
| such as [5]_: | |||
| such as [Hobbs1977]_: | |||
metpy/calc/thermo.py
Outdated
| @@ -499,7 +476,7 @@ def saturation_mixing_ratio(tot_press, temperature): | |||
| r"""Calculate the saturation mixing ratio of water vapor. | |||
|
|
|||
| This calculation is given total pressure and the temperature. The implementation | |||
| uses the formula outlined in [6]_. | |||
| uses the formula outlined in [Hobbs1977]_. | |||
metpy/calc/thermo.py
Outdated
| @@ -526,7 +498,7 @@ def equivalent_potential_temperature(pressure, temperature): | |||
| r"""Calculate equivalent potential temperature. | |||
|
|
|||
| This calculation must be given an air parcel's pressure and temperature. | |||
| The implementation uses the formula outlined in [7]_. | |||
| The implementation uses the formula outlined in [Hobbs1977]_. | |||
|
One other issue is the colormap plot in the docs. This is what I see when I build locally: |
|
Really? hmm. I rendered with RTD and didn't see that, but I'll change it up and see if I can reproduce. |
|
|
|
Works for me if I add |
|
Modified the aspect ratio a bit - should be good to go. |
dopplershift
approved these changes
Mar 24, 2017
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.
Improvements on documentation including references and method documentation. Addresses #314