documentation review

[jonathancallahan]

Good documentation is important for end users and is a good place to start when learning a new package. The MazamaCoreUtils package is taking on increasing importance as a solid base from which we build other packages and utilities.

This first task encourages you to become very familiar with this package by reviewing all function documentation and vignettes for typos and poor wording. It is also an opportunity to become familiar with the mechanics of building and testing a package, using git to add-commit-push changes and using Github to submit a pull request.

Documentation for the current development version of MazamaCoreUtils is available at:

https://mazamascience.github.io/MazamaCoreUtils/index.html

The specific component tasks are:

• git clone https://github.com/MazamaScience/MazamaCoreUtils.git and create a kayleigh branch to do your work
• create a local version of the web docs by running devtools::check() and then pkgdown::build_site()
• Copy edit the web version of the function reference documentation looking for typos, mistakes and poor wording.
• Make your edits, recheck and rebuild the site until the documentation is error free
• Repeat this process with the vignettes
• add-commit-push your changes to the kayleigh branch and submit a pull request