Skip to content

Documentation #36

@DaveOri

Description

@DaveOri

readthedocs is broken. Probably some errors in the compilation prevents from filling the pages with autodocs.

I also received some requests from users to improve the documentation. General points would be:

  • description of input and outputs, with units
  • more clear examples (not sure how to get this, maybe some different use-cases)
  • description of the domain (x,y,z,time). Difference between _lev and layer coordinates, something like that...

I will try to start a github project on this. There are going to be several sub-issues and assignments to address. Any contribution will be helpful, even just writing tasks in the to-do list would be great

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