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

Fully maintain DESCRIPTION from package-level doc? #1470

Closed
MichaelChirico opened this issue Mar 10, 2023 · 1 comment
Closed

Fully maintain DESCRIPTION from package-level doc? #1470

MichaelChirico opened this issue Mar 10, 2023 · 1 comment

Comments

@MichaelChirico
Copy link
Contributor

Package-level documentation (https://usethis.r-lib.org/reference/use_package_doc.html) is a very natural place to keep some package-level roxygen entries, e.g. @import/@importFrom in the namespace.

The structure of that object is also very similar to a DESCRIPTION:

#' This is basically the Title field
#'
#' This can replace the Description: field.

As such I find it a bit redundant to maintain both the DESCRIPTION and the package-level doc file separately.

It seems natural to me to be able to maintain the DESCRIPTION entirely from within the R folder, supported by roxygenizing. There's a lot of detail to flesh out (e.g. all the other DESCRIPTION fields that don't have a corresponding roxygen tag today), but first -- is that something that would be in scope for the package?

@hadley
Copy link
Member

hadley commented Jun 22, 2023

I think we've mostly been moving in the opposite direction, generating more of the package documentation topic from the DESCRIPTION. So I do think this is out of scope.

@hadley hadley closed this as completed Jun 22, 2023
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

No branches or pull requests

2 participants