Completes missing documentation for color palettes, suggests {stringr}, and fixes vignette bugs.
@ehesch, scale_fill_council() and its friends were not properly documented in the previous PR. I did not have a GHA set up to check for this, so that is on me.
R packages require a specific documentation format. Package documentation is compiled by{roxygen2}. Roxygen has keywords and tags it uses to index functions and add them to the NAMESPACE. A favorite keyboard shortcut for roxygen is "Cmd + Alt + Shift + R", which generates a roxygen skeleton for the function you are working on.
You can read more about function and data documentation in Hadley Wickham's book here.
Also, I suggest you utilize rcmdcheck::rcmdcheck(), which will go beyond basic testing and scan code for problems.
Completes missing documentation for color palettes, suggests
{stringr}, and fixes vignette bugs.@ehesch,
scale_fill_council()and its friends were not properly documented in the previous PR. I did not have a GHA set up to check for this, so that is on me.R packages require a specific documentation format. Package documentation is compiled by
{roxygen2}. Roxygen has keywords and tags it uses to index functions and add them to theNAMESPACE. A favorite keyboard shortcut for roxygen is "Cmd + Alt + Shift + R", which generates a roxygen skeleton for the function you are working on.You can read more about function and data documentation in Hadley Wickham's book here.
Also, I suggest you utilize
rcmdcheck::rcmdcheck(), which will go beyond basic testing and scan code for problems.