Skip to content

reformat a few docstrings for sphinx, and remove some docstrings that…#23

Merged
eacharles merged 1 commit intomainfrom
eac/docs
Feb 18, 2025
Merged

reformat a few docstrings for sphinx, and remove some docstrings that…#23
eacharles merged 1 commit intomainfrom
eac/docs

Conversation

@eacharles
Copy link
Collaborator

… are already in base classes

Problem & Solution Description (including issue #)

Code Quality

  • My code follows the code style of this project
  • I have written unit tests or justified all instances of #pragma: no cover; in the case of a bugfix, a new test that breaks as a result of the bug has been added
  • My code contains relevant comments and necessary documentation for future maintainers; the change is reflected in applicable demos/tutorials (with output cleared!) and added/updated docstrings use the NumPy docstring format
  • Any breaking changes, described above, are accompanied by backwards compatibility and deprecation warnings

@eacharles eacharles self-assigned this Feb 17, 2025
@codecov
Copy link

codecov bot commented Feb 17, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (17f7b47) to head (74c29fb).
Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main       #23   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            3         3           
  Lines          193       193           
=========================================
  Hits           193       193           

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

@eacharles eacharles merged commit 6e2708e into main Feb 18, 2025
7 checks passed
@eacharles eacharles deleted the eac/docs branch February 18, 2025 04:36
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