search

CliMA / Oceananigans.jl

🌊 Julia software for fast, friendly, flexible, ocean-flavored fluid dynamics on CPUs and GPUs
https://clima.github.io/OceananigansDocumentation/stable
MIT License
987 stars 194 forks source link

Docstrings for modules #728

Open glwagner opened 4 years ago

glwagner commented 4 years ago

We need docstrings on the top-level module and submodules. This way we can write

help?> Oceananigans

and get something useful. The docstring should explain the basic usage of the module and print the functions that are exported, I think? The top-level docstring could also link to the online documentation.

glwagner commented 4 years ago

cc @christophernhill

navidcy commented 1 year ago

There is something for Oceananigans. But true, we need more ;)

help?> Oceananigans
search: Oceananigans OceananigansLogger

  Main module for Oceananigans.jl – a Julia software for fast, friendly, flexible, data-driven, ocean-flavored fluid dynamics on CPUs and GPUs.