Reference docs shared by multiple functions in a package

[apreshill]

Hi-

I'm wondering about the vocabulary for when a reference doc is the same for a number of different functions because each function shares the same usage/arguments/values- what do you call that family of functions then, and then what is each one? A unique function alias? Some tidyverse examples of what I am referring to:

• https://readr.tidyverse.org/reference/read_delim.html
• https://readr.tidyverse.org/reference/parse_atomic.html
• https://dplyr.tidyverse.org/reference/summarise_all.html

Many thanks in advance!
Alison

[nwerth]

If you're using roxygen2, you can use the @describeIn or @rdname tags. Details in the online docs: Documenting multiple functions in the same file (Generating Rd files).

If you're not using roxygen2, you should start using it. Keeping the documentation with the corresponding objects makes things a lot easier, and the notation is easier to read than the usual \LaTeX-like format.

[apreshill]

Thank you so much for this link!