Skip to content

docs: improve NumPy-style docstrings in render module#454

Merged
IgorTatarnikov merged 10 commits into
brainglobe:mainfrom
AlgoFoe:format-api-ref-render
Jun 24, 2026
Merged

docs: improve NumPy-style docstrings in render module#454
IgorTatarnikov merged 10 commits into
brainglobe:mainfrom
AlgoFoe:format-api-ref-render

Conversation

@AlgoFoe

@AlgoFoe AlgoFoe commented Jun 15, 2026

Copy link
Copy Markdown
Contributor

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 render.py.

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 Jun 15, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 88.26%. Comparing base (55c8b6c) to head (53966da).

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #454      +/-   ##
==========================================
- Coverage   89.41%   88.26%   -1.15%     
==========================================
  Files          27       27              
  Lines        1285     1287       +2     
==========================================
- Hits         1149     1136      -13     
- 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 marked this pull request as ready for review June 15, 2026 17:58

@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.

This looks great, just a few small comments and then I think it'll be good to go!

Comment thread brainrender/render.py Outdated
Comment thread brainrender/render.py Outdated
Comment thread brainrender/render.py Outdated
@alessandrofelder

Copy link
Copy Markdown
Member

@AlgoFoe maybe while you are fixing **kwargs typehints, you could also fix it at

**kwargs: object,
(sorry for missing this when I reviewed!)

@AlgoFoe AlgoFoe requested a review from IgorTatarnikov June 22, 2026 16:48

@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.

LGMT 🎉. Thanks for addressing the comments!

@IgorTatarnikov IgorTatarnikov merged commit 9251a52 into brainglobe:main Jun 24, 2026
19 of 21 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.

3 participants