You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
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-
changed the title
Aliases are not included in reference index
Aliases starting with @ are not included in reference index
Nov 5, 2020
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
I think this is a bug since they are documented to be included:
This seems to fix it: lionel-@c14cf12
I can open a pull request if this is indeed a bug and the patch looks reasonable.
The text was updated successfully, but these errors were encountered: