search

NCAR / ADF

A unified collection of python scripts used to generate standard plots from CAM outputs.
Creative Commons Attribution 4.0 International
36 stars 31 forks source link

docstrings for plotting_functions.py #252

Closed brianpm closed 1 year ago

brianpm commented 1 year ago

This PR is only for improved documentation of plotting_functions.py.

It modifies all docstrings in the module.

Docstrings follow Numpy conventions: https://numpydoc.readthedocs.io/en/latest/format.html

I think I got everything. A few of them don't have as much info, but I think I pretty fully described the functions that users who will be trying to plug in their own scripts would need to see.

Literally this just changes the docstrings, so I didn't do any testing because no code is altered.

brianpm commented 1 year ago

Added docstrings for global_latlon_map