Add more cross-links in documentation #143
Conversation
|
|
||
| Note that moist static energy density ``ρᵣ e`` and moisture density ``ρᵣ qᵗ`` | ||
| are prognostic variables for `Breeze.AtmosphereModel` when using `AnelasticFormulation`, | ||
| are prognostic variables for [`Breeze.AtmosphereModel`](@ref) when using [`AnelasticFormulation`](@ref), |
There was a problem hiding this comment.
Note that documentation is currently failing because AnelasticFormulation doesn't have a docstring at all. Feels like it should?
There was a problem hiding this comment.
I added something via fddf4f7 but feel free to enhance it!
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
|
|
||
| Note that moist static energy density ``ρᵣ e`` and moisture density ``ρᵣ qᵗ`` | ||
| are prognostic variables for `Breeze.AtmosphereModel` when using `AnelasticFormulation`, | ||
| are prognostic variables for [`AtmosphereModel`](@ref) when using [`AnelasticFormulation`](@ref), |
There was a problem hiding this comment.
out of curiosity, is there other formulations available? no, right?
There was a problem hiding this comment.
not yet. we plan to implement a fully compressible formulation though.
There was a problem hiding this comment.
in the fully compressible case, energy_density will be the total energy. There is also the possbility of supporting other energy variables through the formulation mechanism.
|
now I think I may have done a new PR... sorry for infiltrating this :( |
|
It's ok, I appreciate the help! |
|
Unless @glwagner wants to tweak the docstring, this is ready to go I think! |
| @@ -1,31 +1,30 @@ | |||
| """ | |||
| $(TYPEDSIGNATURES) | |||
| saturation_vapor_pressure(T, thermo, phase::CondensedPhase) | |||
There was a problem hiding this comment.
Any reason for not using $(TYPEDSIGNATURES)?
There was a problem hiding this comment.
This was changed by @navidcy in a9009c6. Was that because of the return type? If so, I'd suggest going back to $(TYPEDSIGNATURES) for the time being, and when JuliaDocs/DocStringExtensions.jl#179 lands (hopefully soon!) we can switch to that for the docstrings we want without return type.
There was a problem hiding this comment.
Ok, I'm doing that.
|
|
||
| """ | ||
| $(TYPEDSIGNATURES) | ||
| saturation_specific_humidity(T, ρ, thermo, phase::CondensedPhase) |
There was a problem hiding this comment.
no don't know why this happendd
Co-authored-by: Navid C. Constantinou <[email protected]>
Removed the AnelasticFormulation function and its documentation.
giordano
force-pushed
the
mg/links-docs
branch
from
e9db055 to
ddab964
Compare
| ``` | ||
|
|
||
| This difference ``\Delta c^l ≈`` $(round(1885 - 4181, digits=1)) J/(kg⋅K) is negative because | ||
| This difference ``\Delta c^l ≈`` -2296 J/(kg⋅K) is negative because |
There was a problem hiding this comment.
Now that I look at the rendered code block in https://numericalearth.github.io/BreezeDocumentation/dev/thermodynamics/#Example:-liquid-water-and-ice-parameters, this should have been 2331? That's a bit far from your calculation.
Corrected the value of Δc^l in thermodynamics documentation. See #143 (comment)
* Fix Δc^l value in thermodynamics.md Corrected the value of Δc^l in thermodynamics documentation. See #143 (comment) * Update thermodynamics.md for clarity on heat capacity Clarified explanation of the heat capacity difference.
No description provided.