Skip to content

Add doctest examples and run them in CI #1611

Description

@rajeeja

Most of our docstrings don't have runnable examples. Let's add some >>> examples to the more commonly used public functions (Grid, UxDataArray, UxDataset), and add a CI step to actually run them (pytest --doctest-modules or similar) so they don't rot over time.

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

Status
📚 Backlog

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions