Tidy documentation

[dieghernan]

FFrom https://style.tidyverse.org/documentation.html

Overall

• Titles should use sentence case but not end with a full stop (.).
• For most tags, like @param, @seealso and @return, the text should be a sentence, starting with a capital letter and ending with a full stop.
• For all bullets, enumerations, argument descriptions and the like, use sentence case and put a period at the end of each text element, even if it is only a few words. However, avoid capitalization of function names or packages since R is case sensitive. Use a colon before enumerations or bulleted lists.
• List closely related functions in @seealso. A single related function can be written as a sentence. More recommendations should be organised in a bulleted list.

Functions

Text that contains valid R code should be marked as such using backticks. This includes:

• Function names, which should be followed by (), e.g. tibble().
• Function arguments, e.g. na.rm.
• Values, e.g. TRUE, FALSE, NA, NaN, ..., NULL
• Literal R code, e.g. mean(x, na.rm = TRUE)
• Class names, e.g. “a tibble will have class tbl_df …”
• Do not use code font for package names. If the package name is ambiguous in the context, disambiguate with words, e.g. “the foo package”. Do not capitalize the function name if it occurs at the start of a sentence.

Internal functions

Won't do