Skip to content

Conversation

@teunbrand
Copy link
Collaborator

This PR is upkeep and aims to fix a pet peeve.

The pet peeve is that there were multiple documentation entries for common parameters and tracking the inheritance of some layer parameters is a bit of a pain. This puts all the common parameters in one place. I also replaced the rd_orientation() helper, as it essentially pasted a section that can also be just inherited.

Merge branch 'main' into centralise_layer_arg_docs

# Conflicts:
#	R/utilities-help.R
#	man/geom_bar.Rd
#	man/geom_boxplot.Rd
#	man/geom_density.Rd
#	man/geom_histogram.Rd
#	man/geom_linerange.Rd
#	man/geom_path.Rd
#	man/geom_ribbon.Rd
#	man/geom_smooth.Rd
#	man/geom_violin.Rd
#	man/stat_summary.Rd
@teunbrand teunbrand requested a review from thomasp85 November 18, 2025 10:27
Copy link
Member

@thomasp85 thomasp85 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If @noDoc still allows inheritance I think it is preferred over @keyword internal

#' @keywords internal
#' @aliases NULL
NULL

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does inheritance work while you use @noDoc?

@teunbrand
Copy link
Collaborator Author

If @noDoc still allows inheritance I think it is preferred over @keyword internal

@noDoc isn't recognised by roxygen2, but putting @noRd there causes roxygen2 to not find the inherited parameters.
The @aliases NULL already 'hides' the page from autocompleting when typing ? and I don't know of any other further steps to obfuscate this from users. I'll merge this and if any bright ideas pop up later, we can always adapt.

@teunbrand teunbrand merged commit 8d9f428 into tidyverse:main Nov 18, 2025
21 of 22 checks passed
@teunbrand teunbrand deleted the centralise_layer_arg_docs branch November 18, 2025 13:30
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 this pull request may close these issues.

2 participants