Skip to content

Doc cleanup #625

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

Open
wants to merge 16 commits into
base: dev
Choose a base branch
from
Open

Doc cleanup #625

wants to merge 16 commits into from

Conversation

brookslogan
Copy link
Contributor

@brookslogan brookslogan commented Mar 11, 2025

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

See #563 checklist. Some other items of note are deferred to https://github.com/cmu-delphi/forecasting-team-meta/issues/29.

Magic GitHub syntax to mark associated Issue(s) as resolved when this is merged into the default branch

@brookslogan brookslogan changed the title docs: link-ify vignette("backtesting", package="epipredict") Doc cleanup Mar 13, 2025
@brookslogan brookslogan marked this pull request as ready for review March 17, 2025 23:06
@brookslogan
Copy link
Contributor Author

/preview-docs

@brookslogan
Copy link
Contributor Author

Check issues are probably unrelated, from #631. Will work on that.

Copy link

@brookslogan
Copy link
Contributor Author

  • Long epi_slide title makes it easy to skip (in html reference at least) and then the intro doesn't read that well.

Copy link
Contributor

@nmdefries nmdefries left a comment

Choose a reason for hiding this comment

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

Looks fine. I made a few small wording changes.

On the epix_slide reference page, do we need to show all these versions? Args look exactly the same.
Screenshot from 2025-04-10 14-17-48

@brookslogan
Copy link
Contributor Author

I think roxygen adds those S3 method listings automatically. Any idea how to compress/remove them? I guess we could make them into function(...)'s that then forward to some internal epix_slide[grouped_]_epi_archive_impl functions, but I'm hoping there would be a straight roxygen solution.

@nmdefries
Copy link
Contributor

Do the @keywords internal or @noRd work in this case?

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.

epiprocess doc cleanup
2 participants