Skip to content

docs: add numpy-style docstrings to all modules#451

Draft
AlgoFoe wants to merge 3 commits into
brainglobe:mainfrom
AlgoFoe:format-api-ref
Draft

docs: add numpy-style docstrings to all modules#451
AlgoFoe wants to merge 3 commits into
brainglobe:mainfrom
AlgoFoe:format-api-ref

Conversation

@AlgoFoe
Copy link
Copy Markdown

@AlgoFoe AlgoFoe commented Jun 2, 2026

Description

What is this PR

  • Bug fix
  • Addition of a new feature
  • Other

Why is this PR needed?

  • The codebase lacked consistent docstrings, making Sphinx autodoc output incomplete and hard to read.

What does this PR do?

  • Adds/updates NumPy-style docstrings (module, class, method, function level) across all modules.

References

  • Issue-96

How has this PR been tested?

  • No functional changes, existing tests pass.

Is this a breaking change?

  • No.

Does this PR require an update to the documentation?

  • Yes.

Checklist:

  • The code has been tested locally
  • Tests have been added to cover all new functionality (unit & integration)
  • The documentation has been updated to reflect any changes
  • The code has been formatted with pre-commit

@codecov
Copy link
Copy Markdown

codecov Bot commented Jun 2, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 89.37%. Comparing base (6d1c05d) to head (8e1676e).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #451   +/-   ##
=======================================
  Coverage   89.37%   89.37%           
=======================================
  Files          27       27           
  Lines        1280     1280           
=======================================
  Hits         1144     1144           
  Misses        136      136           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@AlgoFoe
Copy link
Copy Markdown
Author

AlgoFoe commented Jun 3, 2026

The failing CI job looks unrelated to the docstring changes (atlas download timeout). I'll continue updating the remaining modules in this.

@adamltyson
Copy link
Copy Markdown
Member

Yep, we're having ongoing issues with our hosting until we complete the move to AWS.

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.

2 participants