Skip to content

Fix docstrings #32

@SarahAlidoost

Description

@SarahAlidoost

For docstrings, let's pick google convention because numpy convention uses "parameters" for arguments and that can be confusing in this project. Format all docstrings properly. Check this in the documentation page with API reference.

Update: it seems that mkdocs renders the google style Args as Parameters, see Griffe docs.

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

Status

Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions