Skip to content

Test code snippets in docstrings #5095

@pbrubeck

Description

@pbrubeck

Ideally we should be testing code snippets so they don't bitrot. This includes the ones under the examples in the docstrings. One way to test them is with doctest, which also needs the output from each example in the docstring, but this might not be ideal if the output is non-numeric.

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions