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.

Sign up for GitHub

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

Jump to bottom

add @noamross suggested modification to family tag text #361

Merged
merged 3 commits into from
Nov 18, 2021
Merged

add @noamross suggested modification to family tag text #361

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c00e2e7
add @noamross suggested modification to family tag text
mpadge Nov 18, 2021
16a91cf
thanks to @maelle for additional useful hyperlink
mpadge Nov 18, 2021
20e3bea
update changelog for #361
mpadge Nov 18, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion pkg_building.Rmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,7 @@ can be found at *link*".

* All functions should document the type of object returned under the `@return` heading.

* We recommend using the `@family` tag in the documentation of functions to allow their grouping in the documentation of the installed package and potentially in the package's website, see [the "manual" section of The R Packages book](https://r-pkgs.org/man.html) and [the "function grouping" section of the present chapter](#function-grouping) for more details.
- Documentation should support user navigation by including useful cross-links between related functions and documenting related functions together in groups or in common help pages. The @seealso and @family tags (the latter of which automatically creates “See also” links and groups functions together on pkgdown sites), are recommended for this purpose. See [the "manual" section of The R Packages book](https://r-pkgs.org/man.html) and [the "function grouping" section of the present chapter](#function-grouping) for more details.
mpadge marked this conversation as resolved.
Show resolved Hide resolved

* You could re-use documentation pieces (e.g. details about authentication, related packages) across the vignettes/README/man pages. A possible approach for that is the use of [R Markdown fragments, relying on knitr use of child documents so you can store the re-used parts in a folder in man/, and call them from both the README and the vignette](https://www.garrickadenbuie.com/blog/dry-vignette-and-readme/) as well [as in man pages by using the `@includeRmd` tag available from `roxygen 0.7.0`](https://roxygen2.r-lib.org/articles/rd.html#including-external--rmd-md-files).

Expand Down