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

Mark internal functions with @keywords internal to hide them from reference index #25

Closed
thackl opened this issue Feb 1, 2021 · 0 comments
Assignees
Labels
documentation Doc needs more work

Comments

@thackl
Copy link
Owner

thackl commented Feb 1, 2021

pkgdown throws errors if documented functions are "missing topics" when building the reference index. Right now we have all functions in the index, also some just have doc and relevance for internal usage, and ideally should not be part of the index.

Apparently @keywords internal can be used to hide those r-lib/pkgdown#1378 (comment)

@thackl thackl added the documentation Doc needs more work label Feb 1, 2021
@thackl thackl self-assigned this Feb 1, 2021
@thackl thackl closed this as completed in ed441ad Feb 1, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Doc needs more work
Projects
None yet
Development

No branches or pull requests

1 participant