search

CliMA / SeawaterPolynomials.jl

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

More LaTeX docstring formatting + fix typos in `RoquetSeawaterPolynomial` docs #25

Closed navidcy closed 1 year ago

codecov[bot] commented 1 year ago

Codecov Report

Base: 62.90% // Head: 62.90% // No change to project coverage :thumbsup:

Coverage data is based on head (1a0b1e6) compared to base (9b51e6a). Patch has no changes to coverable lines.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #25 +/- ## ======================================= Coverage 62.90% 62.90% ======================================= Files 3 3 Lines 62 62 ======================================= Hits 39 39 Misses 23 23 ``` | [Impacted Files](https://codecov.io/gh/CliMA/SeawaterPolynomials.jl/pull/25?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=CliMA) | Coverage Δ | | |---|---|---| | [src/SecondOrderSeawaterPolynomials.jl](https://codecov.io/gh/CliMA/SeawaterPolynomials.jl/pull/25?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=CliMA#diff-c3JjL1NlY29uZE9yZGVyU2Vhd2F0ZXJQb2x5bm9taWFscy5qbA==) | `53.84% <ø> (ø)` | | | [src/TEOS10.jl](https://codecov.io/gh/CliMA/SeawaterPolynomials.jl/pull/25?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=CliMA#diff-c3JjL1RFT1MxMC5qbA==) | `90.47% <ø> (ø)` | | 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.

navidcy commented 1 year ago

@glwagner so in the docs in a few places there were terms like R₁₀₀ * Θ or R₀₁₀ * Sᴬ while from what I understand they should be R₀₁₀ * Θ and R₁₀₀ * Sᴬ, since the first subscript of R refers to S and second to Θ. I fixed them. But I'm wondering if the mistakes are in the code as well...

navidcy commented 1 year ago

@glwagner so in the docs in a few places there were terms like R₁₀₀ * Θ or R₀₁₀ * Sᴬ while from what I understand they should be R₀₁₀ * Θ and R₁₀₀ * Sᴬ, since the first subscript of R refers to S and second to Θ. I fixed them. But I'm wondering if the mistakes are in the code as well...

From what I see the code is ok.

navidcy commented 1 year ago

Another question: is Θ expected in degrees C or degrees K?

glwagner commented 1 year ago

Another question: is Θ expected in degrees C or degrees K?

I believe C

glwagner commented 1 year ago

@glwagner so in the docs in a few places there were terms like R₁₀₀ * Θ or R₀₁₀ * Sᴬ while from what I understand they should be R₀₁₀ * Θ and R₁₀₀ * Sᴬ, since the first subscript of R refers to S and second to Θ. I fixed them. But I'm wondering if the mistakes are in the code as well...

From what I see the code is ok.

Oh! I can't remember the system but yes, there is a system defined in the Roquet paper and we should follow that