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.

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

Update some of the documentation #43

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

kellijohnson-NOAA
Copy link

Thank you for creating whisker and publishing the code on GitHub. I was going through trying to learn more about the package and noticed a few minor typos in the README and some of the functions. This pull request fixes those typos (link to Mustache, use of arguments in install_github, () for functions, and some spelling errors).

Note that I did not render the README.Rmd file to update the README.md nor did I run document() because I wasn't sure of your workflow for the README and I have a different version of roxygen2 than what was used for the package. I am happy to edit this pull request if you would like me to do those things.

remotes::install_github no longer uses repo and user
Instead, guidance for repo is
username/repo[/subdir][@ref|#pull|@*release]
and user is deprecated.
tidyverse style guide suggests using () after all function calls
to notify readers that it is a function rather than a variable

place double in brackets after example to create consistency with
the triple example
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant