Skip to content

docs: improve NumPy-style docstrings in actors modules - #463

Merged
IgorTatarnikov merged 9 commits into
brainglobe:mainfrom
AlgoFoe:format-api-ref-actors
Aug 6, 2026
Merged

docs: improve NumPy-style docstrings in actors modules#463
IgorTatarnikov merged 9 commits into
brainglobe:mainfrom
AlgoFoe:format-api-ref-actors

Conversation

@AlgoFoe

@AlgoFoe AlgoFoe commented Aug 3, 2026

Copy link
Copy Markdown
Member

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) in actors modules.

References

  • Part of 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

codecov Bot commented Aug 3, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 88.49%. Comparing base (afdb216) to head (bf2d0c3).

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #463      +/-   ##
==========================================
- Coverage   89.58%   88.49%   -1.09%     
==========================================
  Files          27       27              
  Lines        1306     1313       +7     
==========================================
- Hits         1170     1162       -8     
- Misses        136      151      +15     

☔ 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
AlgoFoe requested a review from IgorTatarnikov August 5, 2026 13:45

@IgorTatarnikov IgorTatarnikov left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 🎉 , thanks @AlgoFoe!

@IgorTatarnikov
IgorTatarnikov merged commit b329794 into brainglobe:main Aug 6, 2026
11 of 12 checks passed
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