Package notation differs from Oceananigans
documentationinvalid
When reading a few docstrings, I noticed that a different notation is used from the notation that is used in the Oceananigans source code in some places. For example, the "nonhydrostatic pressure anomaly" is called `pₙₕₛ` here:
https://github.com/tomchor/Oceanostics.jl/blob/5512355a520fa979426180a786e656c2f8cdce87/src/TKEBudgetTerms.jl#L114
but in Oceananigans it is called `pNHS`:
https://github.com/CliMA/Oceananigans.jl/blob/51a77cc6ab9d7f66eb84ed574709adac3c9210c9/src/Models/NonhydrostaticModels/nonhydrostatic_model.jl#L213
Notation in Oceananigans is strict/meaningful --- for example, `set!(model, c=...)` requires the kwarg and tracer name to match. There should be no exceptions to this (or if there are, its a bug).
I do like `pₙₕₛ` (I think `pₙ` would be even better) , and support changing Oceananigans to match the notation here. Either way one has to change.
8 条评论