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

Can the title for the reference be changed? #2181

Closed
ramiromagno opened this issue Aug 16, 2022 · 5 comments · Fixed by #2475
Closed

Can the title for the reference be changed? #2181

ramiromagno opened this issue Aug 16, 2022 · 5 comments · Fixed by #2475
Labels
feature a feature request or enhancement reference 📚
Milestone

Comments

@ramiromagno
Copy link

The title of the reference page is by default "Function reference". Can I change it?

@maelle
Copy link
Collaborator

maelle commented Aug 23, 2022

At the moment no unless you provide a custom template https://pkgdown.r-lib.org/articles/customise.html#additional-html-and-files

Your question made me think of #2183, but I wouldn't bet on it. 😸

@ramiromagno
Copy link
Author

Thanks!

@courtiol
Copy link

courtiol commented Nov 4, 2023

Flexibility would be nice, but if not, perhaps changing the title would be enough.
What I personally don't like with "Function reference" is that it lists datasets as well which are clearly not functions.
What about "Package objects" or similar?

@hadley hadley added this to the 2.1.0 milestone Apr 11, 2024
@hadley
Copy link
Member

hadley commented Apr 11, 2024

Maybe we should just change it to reference index?

@hadley
Copy link
Member

hadley commented Apr 18, 2024

Or package index, as suggested by @hfrick and @mikemahoney218.

In either case, this should wait until 2.10, since we'll need to get new translations.

hadley added a commit that referenced this issue Apr 18, 2024
To something that isn't so function specific. Fixes #2181.
hadley added a commit that referenced this issue May 3, 2024
To something that isn't so function specific. Fixes #2181.
SebKrantz pushed a commit to SebKrantz/pkgdown that referenced this issue Jun 1, 2024
To something that isn't so function specific. Fixes r-lib#2181.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature a feature request or enhancement reference 📚
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants