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

Aliases starting with @ are not included in reference index #1436

Closed
lionel- opened this issue Nov 5, 2020 · 2 comments
Closed

Aliases starting with @ are not included in reference index #1436

lionel- opened this issue Nov 5, 2020 · 2 comments

Comments

@lionel-
Copy link
Member

lionel- commented Nov 5, 2020

I think this is a bug since they are documented to be included:

#' * A **list of topics** (`contents`), which generates one row for each topic,
#'   with a list of aliases for the topic on the left, and the topic title
#'   on the right.

This seems to fix it: lionel-@c14cf12

I can open a pull request if this is indeed a bug and the patch looks reasonable.

@lionel-
Copy link
Member Author

lionel- commented Nov 5, 2020

oops that's only the case when the aliases start with @. Hadley says on Slack that it's on purpose. Maybe we can find a way to optionally include them in the index? This would be useful to document roxygen tags as Rd topics for example.

@lionel- lionel- changed the title Aliases are not included in reference index Aliases starting with @ are not included in reference index Nov 5, 2020
@hadley
Copy link
Member

hadley commented Sep 23, 2021

Related to #1624 — the common thread is we want to document things that aren't functions (or even exist as objects in the package), and thus don't appear in the usage. Maybe there would be some way to side load this information to usage?

Anyway, I'm going to close for now, but the general idea remains alive in r-lib/roxygen2#1170

@hadley hadley closed this as completed Sep 23, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants