Skip to content

Make @docType package work more like _PACKAGE#1535

Merged
hadley merged 3 commits intomainfrom
doctype-package
Nov 21, 2023
Merged

Make @docType package work more like _PACKAGE#1535
hadley merged 3 commits intomainfrom
doctype-package

Conversation

@hadley
Copy link
Copy Markdown
Member

@hadley hadley commented Nov 16, 2023

While recommending that you update to the newer syntax.

Fixes #1491

While recommending that you update to the newer syntax.

Fixes #1491
@hadley hadley merged commit 912778b into main Nov 21, 2023
@hadley hadley deleted the doctype-package branch November 21, 2023 13:32
@bastistician
Copy link
Copy Markdown
Contributor

In principle, multiple help pages could be classified with \docType{package}, not only the PKG-package overview page. For example, I have seen packages that set this type also for PKG-deprecated or PKG-defunct overview pages, justifiably, even if the docType info is currently not used much by R itself ... So I am not sure if it makes sense to both deprecate and expand @docType package towards "_PACKAGE". OTOH, also roxygen2 users can always create additional Rd files directly if needed.

I haven't looked at the internals, but maybe a less disruptive alternative could be for @docType package to only make sure that there is a PKG-package alias if also @name PKG (almost restoring the pre-7.0.0 behavior), and only in this case (where the desired alias was not set) throw a message about the new "_PACKAGE" feature (so people can opt out).

@hadley
Copy link
Copy Markdown
Member Author

hadley commented Jan 10, 2024

While in principle, there might be multiple topics with \docType{package}, I don't think there's any practical advantage to it? As far as I know there is no special treatment for these topics.

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.

broken @docType package documentation

2 participants