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.

Sign up for GitHub

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

Jump to bottom

Refactor nametuples to ease docstrings #80

Closed
gvegayon opened this issue Apr 15, 2024 · 1 comment · Fixed by #94
Closed

Refactor nametuples to ease docstrings #80

gvegayon opened this issue Apr 15, 2024 · 1 comment · Fixed by #94
Assignees
@AFg6K7h4fhy2
Labels
documentation Improvements or additions to documentation
Milestone
🦛🐲Hippodraco

Comments

@gvegayon
Copy link
Member

Goal

Currently, each namedtuple is declared in a single line, however, this makes documentation somewhat awkward. We need to refactor nametuples to match the class definition as in here.

Context

See https://github.com/CDCgov/multisignal-epi-inference/pull/74/files#r1562868718

Required features

TBD

Specifications

TBD
@gvegayon gvegayon added documentation Improvements or additions to documentation development task labels Apr 15, 2024
@gvegayon gvegayon mentioned this issue Apr 15, 2024
Merged
@gvegayon gvegayon added this to the 🦛🐲Hippodraco milestone Apr 15, 2024
@AFg6K7h4fhy2
Copy link
Collaborator

Nice catch, I support this, as the current system in place for documenting the namedtuples using __doc__ is somewhat awkward.

@AFg6K7h4fhy2 AFg6K7h4fhy2 linked a pull request Apr 29, 2024 that will close this issue
Clean Model Documentation #94
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@AFg6K7h4fhy2 AFg6K7h4fhy2

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
🦛🐲Hippodraco
Development

Successfully merging a pull request may close this issue.

Clean Model Documentation CDCgov/PyRenew
2 participants
@gvegayon @AFg6K7h4fhy2