search

tomchor / Oceanostics.jl

Diagnostics for Oceananigans
https://tomchor.github.io/Oceanostics.jl/
MIT License
24 stars 8 forks source link

Add doctest for `ErtelPotentialVorticty` in docstring #174

Closed tomchor closed 1 month ago

tomchor commented 1 month ago

This PR adds a doctest with an example of how to compute the ErtelPotentialVorticity to its docstring. It's probably a good idea to improve the test for ErtelPotentialVorticity too since right now it only tests that it calculates something, when really we wanna make sure it calculates the correct output.