-
Notifications
You must be signed in to change notification settings - Fork 336
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
Topic named after objects in Usage section rather than specified topic name #1624
Comments
This comes from the lines pkgdown/R/build-reference-index.R Lines 50 to 54 in 88b3b3d
I can't think of a good solution that'd work automatically. Workarounds currently would be to make sure the Rd title contains the important keywords. |
I'm not sure if we can fix this (or if it's worth the effort to figure out how to fix it). We already have a fairly sophisticated set of heuristics to figure out what to display because generally the usage gives the user the most informative targets for clicking — it's only in relatively few cases where you actually want to see the topic name or raw aliases. |
Maybe if there's no funs we should use all the aliases? I think that will affect little existing documentation, but open the door to creative use. |
From r-lib/rlang#959.
The topic was defined as
@name bang-bang
but pkgdown included it in the reference index under the nameqq_show
. When I removedqq_show()
from the Usage section, it got indexed under its intended name.The text was updated successfully, but these errors were encountered: