Skip to content

convert function docstrings to numpydoc style#190

Open
mohitulm wants to merge 2 commits into
mainfrom
numpydoc_style_docstring
Open

convert function docstrings to numpydoc style#190
mohitulm wants to merge 2 commits into
mainfrom
numpydoc_style_docstring

Conversation

@mohitulm

Copy link
Copy Markdown
Contributor

This PR has docstrings converted from the current format to the standard numpydoc style format

Description

The conversion has been done automatically with scripts and then manually inspected. No changes have been made to the code. Some cases, such as where no additional information is present apart from the parameter's name or an empty return, have been omitted to reduce ambiguity. All the information is preserved.

Motivation and Context

To have a fixed standard for docstrings.

How Has This Been Tested?

This has been tested with the current testing framework.

Types of changes

  • Bug fix
  • New feature
  • Breaking change (Causes existing functionality to not work as expected)

Checklist:

  • My code follows the code style of this project.
  • I have documented my changes in /docs/changelog.md.
  • My change requires additional/updated documentation.
  • I have updated the documentation accordingly.
  • I have added/updated the config example for any module docstrings as necessary.
  • I have checked that the change does not contain obvious errors
    (syntax, indentation, mutable default values, etc.).
  • I have tested my changes using 'Load all modules' on the default dummy configuration.
  • All changed Jupyter notebooks have been stripped of their output cells.

@mohitulm
mohitulm requested a review from prithviulm April 23, 2025 20:12
@TobiasSpohn
TobiasSpohn marked this pull request as ready for review September 17, 2025 15:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants