Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

First Pass Documentation (docstrings) For Top Level Pyrenew Files #89

Merged
merged 13 commits into from
Apr 22, 2024

Conversation

AFg6K7h4fhy2
Copy link
Collaborator

This pull request includes a first pass for:

  • Correction and or modifications of existing docstrings in files contained in ./model/src/pyrenew/
  • Addition of new docstrings in files contained in ./model/src/pyrenew/

Other relevant PRs: (closed: #73 , #74 , #76; open: #87 , #86 )

@AFg6K7h4fhy2 AFg6K7h4fhy2 added the documentation Improvements or additions to documentation label Apr 22, 2024
@AFg6K7h4fhy2 AFg6K7h4fhy2 self-assigned this Apr 22, 2024
Copy link

codecov bot commented Apr 22, 2024

Codecov Report

Attention: Patch coverage is 91.30435% with 2 lines in your changes are missing coverage. Please review.

Project coverage is 90.57%. Comparing base (437016d) to head (03d68c5).

Files Patch % Lines
model/src/pyrenew/convolve.py 71.42% 2 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main      #89      +/-   ##
==========================================
+ Coverage   90.49%   90.57%   +0.08%     
==========================================
  Files          28       28              
  Lines         547      552       +5     
==========================================
+ Hits          495      500       +5     
  Misses         52       52              
Flag Coverage Δ
unittests 90.57% <91.30%> (+0.08%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

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

Copy link
Member

@gvegayon gvegayon left a comment

Choose a reason for hiding this comment

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

Minor comments

model/pyproject.toml Outdated Show resolved Hide resolved
model/src/pyrenew/convolve.py Show resolved Hide resolved
model/src/pyrenew/convolve.py Show resolved Hide resolved
model/src/pyrenew/convolve.py Show resolved Hide resolved
Copy link
Member

@gvegayon gvegayon left a comment

Choose a reason for hiding this comment

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

All good, thanks!

@gvegayon gvegayon merged commit afb93a9 into main Apr 22, 2024
8 checks passed
@gvegayon gvegayon deleted the upx3-docs-top branch April 22, 2024 16:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants