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

Reduce doc duplication in general and for version-related params #221

Open
nmdefries opened this issue Nov 28, 2023 · 1 comment
Open

Reduce doc duplication in general and for version-related params #221

nmdefries opened this issue Nov 28, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation P3 very low priority
Milestone
Z: epidatr & epid...

Comments

@nmdefries
Copy link
Contributor

Group as_of, issues, and lag params together under "@param as_of, issues, lag. [versioning] params, mutually exclusive" and link to a separate page that goes in-depth about these parameters. Will help remove a bunch of doc duplication.

More generally, reduce doc duplication/maintenance by using roxygen templates to keep param text in one place only.
@nmdefries nmdefries added documentation Improvements or additions to documentation P3 very low priority labels Nov 28, 2023
@nmdefries nmdefries added this to the Z: epidatr & epidatpy milestone Nov 28, 2023
@nmdefries
Copy link
Contributor Author

Related to #199

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation P3 very low priority
Projects
None yet
Milestone
Z: epidatr & epidatpy
Development

No branches or pull requests
1 participant
@nmdefries