Skip to content

Make documentation rustier/ NumPy compliant #559

@MicahGale

Description

@MicahGale

In Rust there is an expectation that doc strings will include examples.

This could be a good idea to start including more and more in our doc strings.

Along with this we would need to implement doctest in pytest.

Is this a good paradigm?

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationfeature requestAn issue that improves the user interface.good first issueGood for newcomers

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions