Skip to content

docstrings fixed#793

Merged
vgro merged 1 commit intodevelopfrom
792-correct-docstrings-in-core-components
Mar 19, 2025
Merged

docstrings fixed#793
vgro merged 1 commit intodevelopfrom
792-correct-docstrings-in-core-components

Conversation

@vgro
Copy link
Copy Markdown
Collaborator

@vgro vgro commented Mar 18, 2025

Docstring had wrong references, Fixes #792

Type of change

  • New feature (non-breaking change which adds functionality)
  • Optimization (back-end change that speeds up the code)
  • Bug fix (non-breaking change which fixes an issue)

Key checklist

  • Make sure you've run the pre-commit checks: $ pre-commit run -a
  • All tests pass: $ poetry run pytest

Further checks

  • Code is commented, particularly in hard-to-understand areas
  • Tests added that prove fix is effective or that feature works
  • Relevant documentation reviewed and updated

@vgro vgro linked an issue Mar 18, 2025 that may be closed by this pull request
@vgro vgro requested a review from sallymatson March 18, 2025 20:36
@codecov-commenter
Copy link
Copy Markdown

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.61%. Comparing base (3b32615) to head (d82f06b).
Report is 4 commits behind head on develop.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop     #793   +/-   ##
========================================
  Coverage    94.61%   94.61%           
========================================
  Files           74       74           
  Lines         5104     5104           
========================================
  Hits          4829     4829           
  Misses         275      275           

☔ View full report in Codecov by Sentry.
📢 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.

Copy link
Copy Markdown
Collaborator

@sallymatson sallymatson left a comment

Choose a reason for hiding this comment

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

LGTM!

@vgro vgro merged commit 8817614 into develop Mar 19, 2025
16 checks passed
@vgro vgro deleted the 792-correct-docstrings-in-core-components branch March 19, 2025 13:35
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.

Correct docstrings in core components

3 participants