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 Model Folder #74

Merged
merged 12 commits into from
Apr 15, 2024

Conversation

AFg6K7h4fhy2
Copy link
Collaborator

This pull request includes a first pass

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

Note: You will find some TODO placeholders, mostly in the Notes section of some docstrings. These occur where the author was uncertain about standard procedure or the content.

@AFg6K7h4fhy2 AFg6K7h4fhy2 changed the title First Pass Documentation (docstrings) For Model/model Folder First Pass Documentation (docstrings) For Model Folder Apr 12, 2024
@AFg6K7h4fhy2 AFg6K7h4fhy2 added the documentation Improvements or additions to documentation label Apr 12, 2024
Copy link

codecov bot commented Apr 12, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.49%. Comparing base (a9b73d8) to head (ad7ba91).

Additional details and impacted files
@@            Coverage Diff             @@
##             main      #74      +/-   ##
==========================================
+ Coverage   90.45%   90.49%   +0.03%     
==========================================
  Files          28       28              
  Lines         545      547       +2     
==========================================
+ Hits          493      495       +2     
  Misses         52       52              
Flag Coverage Δ
unittests 90.49% <100.00%> (+0.03%) ⬆️

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.

@AFg6K7h4fhy2 AFg6K7h4fhy2 self-assigned this Apr 12, 2024
@AFg6K7h4fhy2 AFg6K7h4fhy2 requested a review from gvegayon April 12, 2024 16:03
model/pyproject.toml Outdated Show resolved Hide resolved
model/src/pyrenew/model/hospitalizations.py Show resolved Hide resolved
model/src/pyrenew/model/rtinfectionsrenewal.py Outdated Show resolved Hide resolved
pipeline/pyproject.toml Outdated Show resolved Hide resolved
Copy link
Collaborator

@dylanhmorris dylanhmorris left a comment

Choose a reason for hiding this comment

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

Some comments

model/src/pyrenew/model/hospitalizations.py Show resolved Hide resolved
model/src/pyrenew/model/hospitalizations.py Outdated Show resolved Hide resolved
model/src/pyrenew/model/hospitalizations.py Outdated Show resolved Hide resolved
model/src/pyrenew/model/hospitalizations.py Outdated Show resolved Hide resolved
model/pyproject.toml Outdated Show resolved Hide resolved
model/src/pyrenew/model/rtinfectionsrenewal.py Outdated Show resolved Hide resolved
model/src/pyrenew/model/rtinfectionsrenewal.py Outdated Show resolved Hide resolved
model/src/pyrenew/model/rtinfectionsrenewal.py Outdated Show resolved Hide resolved
@AFg6K7h4fhy2
Copy link
Collaborator Author

Some comments

I will take these considerations into account for the other PRs as well. Only need to repeat yourself then if I happen to miss something that was recommended in this thread while editing those PRs.

@gvegayon gvegayon linked an issue Apr 15, 2024 that may be closed by this pull request
6 tasks
gvegayon and others added 2 commits April 15, 2024 13:01
Co-authored-by: Dylan H. Morris <dylanhmorris@users.noreply.github.com>
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.

Looks good to me!

@gvegayon gvegayon removed the request for review from natemcintosh April 15, 2024 19:32
@gvegayon gvegayon merged commit 06e8a22 into main Apr 15, 2024
8 checks passed
@gvegayon gvegayon deleted the upx3-docs-model branch April 15, 2024 19:32
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.

First pass on documentation
3 participants