Skip to content

docs: improve NumPy-style docstrings in camera modules#452

Open
AlgoFoe wants to merge 1 commit into
brainglobe:mainfrom
AlgoFoe:format-api-ref-camera
Open

docs: improve NumPy-style docstrings in camera modules#452
AlgoFoe wants to merge 1 commit into
brainglobe:mainfrom
AlgoFoe:format-api-ref-camera

Conversation

@AlgoFoe

@AlgoFoe AlgoFoe commented Jun 8, 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) across camera 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 Jun 8, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 89.21%. Comparing base (40346b5) to head (c201953).

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #452      +/-   ##
==========================================
- Coverage   89.37%   89.21%   -0.16%     
==========================================
  Files          27       27              
  Lines        1280     1280              
==========================================
- Hits         1144     1142       -2     
- Misses        136      138       +2     

☔ 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 8, 2026 14:44
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.

1 participant