CliMA / SeawaterPolynomials.jl

Polynomials for efficiently computing the density of seawater
https://clima.github.io/SeawaterPolynomials.jl/dev
MIT License
13 stars 2 forks source link

Update docstrings for `SeaWaterPolynomials.jl` #24

Closed jbisits closed 1 year ago

jbisits commented 1 year ago

Purpose

Updates to some docstrings in SeaWaterPolynomials.jl

Content


References

Roquet et al., "Accurate polynomial expressions for the density and specific volume of seawater using the TEOS-10 standard", Ocean Modelling (2015)

codecov[bot] commented 1 year ago

Codecov Report

Base: 61.66% // Head: 62.90% // Increases project coverage by +1.23% :tada:

Coverage data is based on head (fa5fcdf) compared to base (3e4694e). Patch has no changes to coverable lines.

:exclamation: Current head fa5fcdf differs from pull request most recent head 9b51e6a. Consider uploading reports for the commit 9b51e6a to get more accurate results

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #24 +/- ## ========================================== + Coverage 61.66% 62.90% +1.23% ========================================== Files 3 3 Lines 60 62 +2 ========================================== + Hits 37 39 +2 Misses 23 23 ``` | [Impacted Files](https://codecov.io/gh/CliMA/SeawaterPolynomials.jl/pull/24?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=CliMA) | Coverage Δ | | |---|---|---| | [src/SeawaterPolynomials.jl](https://codecov.io/gh/CliMA/SeawaterPolynomials.jl/pull/24?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=CliMA#diff-c3JjL1NlYXdhdGVyUG9seW5vbWlhbHMuamw=) | `40.00% <ø> (+4.28%)` | :arrow_up: | | [src/SecondOrderSeawaterPolynomials.jl](https://codecov.io/gh/CliMA/SeawaterPolynomials.jl/pull/24?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=CliMA#diff-c3JjL1NlY29uZE9yZGVyU2Vhd2F0ZXJQb2x5bm9taWFscy5qbA==) | `53.84% <0.00%> (+1.84%)` | :arrow_up: | Help us with your feedback. Take ten seconds to tell us [how you rate us](https://about.codecov.io/nps?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=CliMA). Have a feature suggestion? [Share it here.](https://app.codecov.io/gh/feedback/?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=CliMA)

:umbrella: View full report at Codecov.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.

glwagner commented 1 year ago

I like the original more concise style that leads with the mathematical definition of the constants better than the style introduced in this PR, but I'm ok to have this change esp with better formatting.

navidcy commented 1 year ago

I like the original more concise style that leads with the mathematical definition of the constants better than the style introduced in this PR, but I'm ok to have this change esp with better formatting.

You mean without the explicit mention of what quantity remains constant over differentiation?