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

data #7

Merged
merged 7 commits into from
Aug 27, 2021
Merged

data #7

merged 7 commits into from
Aug 27, 2021

Conversation

jonthegeek
Copy link
Member

@jonthegeek jonthegeek commented Aug 18, 2021

Author:

Common Mistakes to Catch Fast:

  • Did you increment the version number?
  • Did you re-build and document the package at the very end to make sure all changes were picked up?
  • GP: Test coverage is very low on this, but I'm not fixing in this PR.

Tests:

  • Do you have tests for all of the corner cases you can think of?

Documentation:

  • Are all functions documented, including arguments and return values?
  • Is there at least one example in the documentation of each exported function?
  • README should really be updated in the next PR, but I focused on the vignette here.

Code Quality:

  • Are all parameters validated?
  • Is the parameter that's most likely to be piped into this function the first parameter?
  • Are all internal functions prepended with '.'?
  • Did you deal with all hacky things that you meant to address before PRing?

Reviewer:

Housekeeping:

  • Did you review the author checklist (especially things in bold)?

Documentation:

  • Can you understand what this feature is supposed to do from its help?
  • Does the example seem like a typical use case?

Code Quality:

  • Can you easily determine what each section of code does?

Tests:

  • Can you build the package with your personal Rstudio setup?
  • Do the tests pass for you?
  • Can you think of any missing tests?

Also reorganized files to logically separate things a bit more.
Move toward exportable functions (although we aren't quite there yet).
Copy link
Contributor

@jonathanbratt jonathanbratt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some of the comments are just things to think about later, but there are a couple things we might want to change now. Overall, this is much cleaner than it was! :)

R/vocab.R Show resolved Hide resolved
R/vocab.R Outdated Show resolved Hide resolved
vignettes/generating_vocab.Rmd Outdated Show resolved Hide resolved
vignettes/generating_vocab.Rmd Outdated Show resolved Hide resolved
vignettes/generating_vocab.Rmd Outdated Show resolved Hide resolved
vignettes/generating_vocab.Rmd Outdated Show resolved Hide resolved
@jonathanbratt jonathanbratt merged commit c894665 into main Aug 27, 2021
@jonathanbratt jonathanbratt deleted the data branch August 27, 2021 21:11
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.

2 participants