Skip to content

Usage examples other than API docs #343

@TomNicholas

Description

@TomNicholas

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(...)
"""

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions