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

lockfile_validate pkgdown site docs #2048

Open
jrdnbradford opened this issue Dec 1, 2024 · 0 comments · May be fixed by #2066
Open

lockfile_validate pkgdown site docs #2048

jrdnbradford opened this issue Dec 1, 2024 · 0 comments · May be fixed by #2066

Comments

@jrdnbradford
Copy link
Contributor

jrdnbradford commented Dec 1, 2024

I was looking over the renv site and realized lockfile_validate doesn't show up explicitly in the Reference.

The function has a decent amount of documentation associated with, so if we just add #' @rdname lockfiles to it, it gets merged with the general lockfiles docs in some unexpected ways.

Here are two ways of handling this:

Update pkgdown Config

Add its own reference in the pkgdown config:

- title: Lockfile Management
  contents:
  - lockfiles
  - lockfile_validate

This will maintain its own documentation.

Move Docs to lockfiles.R

We can add a Validation docs header to the docs in lockfiles.R and move the lockfile_validate docs under that, add #' @rdname lockfiles to the function. This way everything related to lockfile management is in one place. But lockfile_validate has @details, @examples, etc that would not be rendered in the same way there.

Any other ways this can be done? I'm happy to fix and open a PR for whatever you think is best here.

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 a pull request may close this issue.

1 participant