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

Move some documentation to templates for easier updating #434

Merged
merged 10 commits into from
Apr 10, 2024

Conversation

nmdefries
Copy link
Contributor

@nmdefries nmdefries commented Apr 4, 2024

Checklist

Please:

  • Make sure this PR is against "dev", not "main" (unless this is a release
    PR).
  • Request a review from one of the current main reviewers:
    brookslogan, nmdefries.
  • Makes sure to bump the version number in DESCRIPTION. Always increment
    the patch version number (the third number), unless you are making a
    release PR from dev to main, in which case increment the minor version
    number (the second number).
  • Describe changes made in NEWS.md, making sure breaking changes
    (backwards-incompatible changes to the documented interface) are noted.
    Collect the changes under the next release number (e.g. if you are on
    1.7.2, then write your changes under the 1.8 heading).
  • See DEVELOPMENT.md for more information on the development
    process.

Change explanations for reviewer

Move duplicated params and other doc text to template files in man-roxygen so it can be easily changed all at once.

Note: R/methods-epi_archive.R is not updated here due to potential conflicts with pending #431.

@nmdefries nmdefries requested a review from dshemetov April 4, 2024 21:58
Copy link
Contributor

@dshemetov dshemetov left a comment

Choose a reason for hiding this comment

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

TIL templates. There are probably a bunch of places we could use this, but happy to introduce incrementally.

Some failing checks, but overall looks good.

@nmdefries nmdefries force-pushed the ndefries/epi_slide-share-docs branch from 79abb58 to d54dd87 Compare April 10, 2024 14:33
@nmdefries nmdefries merged commit 2e694e5 into dev Apr 10, 2024
5 checks passed
@nmdefries nmdefries deleted the ndefries/epi_slide-share-docs branch April 10, 2024 14:41
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.

None yet

2 participants