Skip to content

Docstrings still in the RST format #4176

@timothy-nunn

Description

@timothy-nunn

I have noticed several docstrings that are not in the Numpy docstring style that we moved to a few months ago.

We only care about converting docstrings that are part of the process package (tests do not need to conform, but should where possible).

The incorrect docstrings can be found with the following VSCode search settings:

Image

Here are the files that (at present) contain incorrect docstrings:

Image

Metadata

Metadata

Assignees

Labels

DocumentationImprovements or additions to documentation

Type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions