docreview
docreview copied to clipboard
thisisnic
An opinionated package for enhancing your R package documentation.
Or just check of how well documented they are?
See guidance here: https://developers.google.com/tech-writing/one/short-sentences
https://rviews.rstudio.com/2021/08/04/r-views-blog-contest/
When inline code chunks are too long, they look awful. Add a check which measures lengths of inline code chunks and suggest that they're refactored into actual separate code chunks.
A check is something that has: * config in form of: * a threshold for what score results in a warning * a threshold for what score results in an...
Create helper functions so that adjusting the config can be done through something simple, e.g. `set_thresholds("length", "too_short", c(300, 400))` or similar. Also something to turn checks on and off, like...
Currently docreview uses Flesch-Kincaid to analyse the vignettes. However, there may be other metrics to use as well as or instead of which can provide more useful analyses. Factors identified...
Some word like "obviously", "simply" etc can be counterproductive in documentation. Add a function that can scan vignettes for these words, and also allow the user to supply a custom...
Optional metrics around sentence length, how common words are etc.