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

deprecated parameters are listed as a function deprecation in the reference index #2584

Closed
jayhesselberth opened this issue May 25, 2024 · 3 comments · Fixed by #2592
Closed
Milestone

Comments

@jayhesselberth
Copy link
Collaborator

The recommended way to deprecate a parameter is to add a lifecycle badge the Rd parameter.

New changes in pkgdown pick this up and add the deprecation into the reference index, even if the function itself is not, which looks a little odd and is misleading (i.e., only the parameter is deprecated, not the function).

@hadley
Copy link
Member

hadley commented May 25, 2024

Ooops, I should restrict my search for figures to just the description, not the entire Rd.

@jayhesselberth
Copy link
Collaborator Author

jayhesselberth commented May 25, 2024

or alternatively pick up param lifecycle markup separately and list by the param on the rendered Rd page.

@hadley
Copy link
Member

hadley commented May 28, 2024

@jayhesselberth yeah, that would be nice, but that's going to be a lot more work, and I'd like to see what the reaction to the function-level lifecycle labelling is first.

SebKrantz pushed a commit to SebKrantz/pkgdown that referenced this issue Jun 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants