You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
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.
The text was updated successfully, but these errors were encountered:
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:
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 thelockfile_validate
docs under that, add#' @rdname lockfiles
to the function. This way everything related to lockfile management is in one place. Butlockfile_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.
The text was updated successfully, but these errors were encountered: