Error in docstring for `:Linear` coefficient set - Githubissues

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

Error in docstring for `:Linear` coefficient set #36

Closed jbisits closed 1 month ago

jbisits commented 1 month ago

I think that the coefficients (R₁₀₀, R₀₁₀) in the docstring for the :Linear coefficient set have been switched around

https://github.com/CliMA/SeawaterPolynomials.jl/blob/54499e33783f78f117f12abda7bce2cfe056c832/src/SecondOrderSeawaterPolynomials.jl#L96

In the rest of the coefficient sets R₁₀₀ corresponds to salinity and R₀₁₀ corresponds to temperature

https://github.com/CliMA/SeawaterPolynomials.jl/blob/54499e33783f78f117f12abda7bce2cfe056c832/src/SecondOrderSeawaterPolynomials.jl#L98-L112

This only occurs in this docstring, RoquetEquationOfState(:Linear) sets everything correctly

https://github.com/CliMA/SeawaterPolynomials.jl/blob/54499e33783f78f117f12abda7bce2cfe056c832/src/SecondOrderSeawaterPolynomials.jl#L161-L163

glwagner commented 1 month ago

nice catch