cftime icon indicating copy to clipboard operation
cftime copied to clipboard

Usage examples other than API docs

Open TomNicholas opened this issue 8 months ago • 0 comments

It would be nice if the documentation included usage examples, as currently the only documentation are the docstrings for the public API. Even just adding examples to each docstring using a new section would be nice, e.g.:

"""
<existing docstring>

Examples
--------

Create a cftime object for a non-standard calendar

>>> cftime.date2num(...)
"""

TomNicholas avatar Jun 19 '24 15:06 TomNicholas