Skip to content

Update docstring format #582

@thisisrick25

Description

@thisisrick25

Following up x2 with @alessandrofelder comment on brainglobe.github.io/pull/329

Update the docstring format across the codebase to NumPy Style convention for Sphinx documentation.

Currently, the docstring syntax is inconsistent and throws multiple warnings when sphinx-build or make html is executed.

image

This is also interpreted as an error when used with -w in the docs build command.

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