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

Maintain the complete list of roxygen tags as Rd topics #1165

Closed
lionel- opened this issue Nov 5, 2020 · 1 comment · Fixed by #1402
Closed

Maintain the complete list of roxygen tags as Rd topics #1165

lionel- opened this issue Nov 5, 2020 · 1 comment · Fixed by #1402

Comments

@lionel-
Copy link
Member

lionel- commented Nov 5, 2020

So they are included in the reference index:

Screenshot 2020-11-05 at 13 41 03

I often have trouble finding my way in the roxygen documentation. Having a list of clickable links for each tag would be very helpful I think.

Here is how the index above is implemented, with contents shared in both Rd topics and vignettes: lionel-@eb6f82a3

It requires a solution to that issue so that aliases starting with @ are included in the reference index: r-lib/pkgdown#1436

@maelle
Copy link
Contributor

maelle commented Nov 5, 2020

related: #1080

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants