thisisnic/docreview issues and pull requests

#58 - Plain language

Issue - State: open - Opened by thisisnic almost 3 years ago

#57 - Add check that all exported functions are mentioned in a vignette somewhere

Issue - State: open - Opened by thisisnic almost 3 years ago
Labels: new check

#56 - Add checks for sentence length

Issue - State: open - Opened by thisisnic about 3 years ago
Labels: new check

#55 - Use rviews blog contest and surrounding discussion to inspire new features

Issue - State: open - Opened by thisisnic about 3 years ago

#54 - Check length of inline code chunks

Issue - State: open - Opened by thisisnic over 3 years ago
Labels: new check

#53 - Create helper functions for adjusting the config

Issue - State: open - Opened by thisisnic over 3 years ago

#52 - Refactor code so that checks have a defined structure, have an obvious place where they go, etc

Issue - State: open - Opened by thisisnic over 3 years ago

#51 - Create NEWS.md

Pull Request - State: closed - Opened by thisisnic over 3 years ago

#50 - Check emoji usage

Issue - State: open - Opened by thisisnic over 3 years ago
Labels: new check

#49 - 48 move output

Pull Request - State: closed - Opened by thisisnic over 3 years ago

#48 - Don't output results until all components have been analysed

Issue - State: closed - Opened by thisisnic over 3 years ago

#47 - 5 exclude nullaries

Pull Request - State: closed - Opened by thisisnic over 3 years ago

#46 - Testing - run docreview against packages

Issue - State: closed - Opened by thisisnic over 3 years ago

#45 - Add alt text

Pull Request - State: closed - Opened by thisisnic over 3 years ago

#44 - Revert "Add capability to check for alt text in vignette images"

Pull Request - State: closed - Opened by thisisnic over 3 years ago

#43 - Remove devtools dependency

Issue - State: closed - Opened by thisisnic over 3 years ago

#42 - Add capability to check for alt text in vignette images

Pull Request - State: closed - Opened by thisisnic over 3 years ago

#41 - Document how to add new checks to make it easier for contributors to get involved

Issue - State: open - Opened by thisisnic over 3 years ago
Labels: documentation

#40 - Add ability to only include relevant checks in config file (so if absent, just assume "active" is set to FALSE)

Issue - State: closed - Opened by thisisnic over 3 years ago
Labels: enhancement

#39 - Add advice to improve documentation that doesn't pass checks

Issue - State: open - Opened by thisisnic over 3 years ago
Labels: enhancement

#38 - Add functionality to check if all images have alt text

Issue - State: closed - Opened by spcanelon over 3 years ago - 11 comments
Labels: new check

#37 - Remove parsermd dependency, use regex for parsing

Pull Request - State: closed - Opened by thisisnic over 3 years ago

#36 - Use tokenizers pkg

Issue - State: closed - Opened by thisisnic over 3 years ago

#35 - Configure docreview using a config file

Pull Request - State: closed - Opened by thisisnic over 3 years ago

#34 - Initial vignette commit

Pull Request - State: closed - Opened by thisisnic over 3 years ago

#33 - 14 docreview on docreview

Pull Request - State: closed - Opened by thisisnic over 3 years ago

#32 - 25 tests

Pull Request - State: closed - Opened by thisisnic over 3 years ago

#31 - Rewrite most of the vignette analysis functionality in C++

Issue - State: open - Opened by thisisnic over 3 years ago
Labels: enhancement

#30 - Add ability to specify thresholds for scoring

Issue - State: closed - Opened by thisisnic over 3 years ago - 1 comment
Labels: enhancement

#29 - Functionality to map between every type of review check failure and whether it should generate an error or a warning

Issue - State: closed - Opened by thisisnic over 3 years ago - 1 comment
Labels: enhancement

#28 - Function review feature: check roxygen param tags for duplicated parameters (i.e. suggest use of @inheritparams or whatever)

Issue - State: open - Opened by thisisnic over 3 years ago
Labels: enhancement

#27 - 15 error on fail

Pull Request - State: closed - Opened by thisisnic over 3 years ago - 1 comment

#26 - Rename functions to fit object_verb pattern

Pull Request - State: closed - Opened by thisisnic over 3 years ago

#25 - Fix unit tests and ensure code coverage >= 75%

Issue - State: closed - Opened by thisisnic over 3 years ago - 1 comment

#24 - Refactor main exported functions to an object_verb() naming scheme for functions

Issue - State: closed - Opened by thisisnic over 3 years ago
Labels: refactor

#23 - Implement Reporters (a la testthat) for more options for result reporting

Issue - State: open - Opened by thisisnic over 3 years ago

#22 - Use praise to praise good docs

Issue - State: open - Opened by thisisnic over 3 years ago
Labels: enhancement, help wanted, good first issue

#21 - Speed up CI by removing extra builds

Pull Request - State: closed - Opened by thisisnic over 3 years ago

#20 - Speed up build time by reducing the number of platforms

Issue - State: closed - Opened by thisisnic over 3 years ago
Labels: CI

#19 - Add more metrics for the vignette reviews

Issue - State: open - Opened by thisisnic over 3 years ago
Labels: new check

#18 - Improve vignette parsing/cleaning

Issue - State: closed - Opened by thisisnic over 3 years ago
Labels: enhancement

#17 - Allow (optional) reporting of functions which have examples but some parameters are not documented

Issue - State: open - Opened by thisisnic over 3 years ago
Labels: enhancement

#16 - Tidy code in cli.R

Issue - State: closed - Opened by thisisnic over 3 years ago

#15 - Add option to raise error if problems found with documentation

Issue - State: closed - Opened by thisisnic over 3 years ago - 1 comment
Labels: enhancement

#14 - Add docreview to CI steps

Issue - State: closed - Opened by thisisnic over 3 years ago - 1 comment
Labels: CI

#13 - Add styler to CI steps

Issue - State: open - Opened by thisisnic over 3 years ago
Labels: CI

#12 - Add vignette showing reasoning behind "opinions" in this package

Issue - State: open - Opened by thisisnic over 3 years ago
Labels: documentation

#11 - Add ability to search from problematic words

Issue - State: open - Opened by thisisnic over 3 years ago
Labels: new check

#10 - Add functionality to check pkgdown settings

Issue - State: open - Opened by thisisnic over 3 years ago
Labels: new check

#9 - Use pkgdown

Issue - State: closed - Opened by thisisnic over 3 years ago - 1 comment
Labels: documentation

#8 - Update CI to run tests on PRs but not on merges(?)

Issue - State: closed - Opened by thisisnic over 3 years ago
Labels: CI

#7 - Update README to show usage examples

Issue - State: closed - Opened by thisisnic over 3 years ago - 2 comments
Labels: documentation

#6 - Users should be able to supply a list of functions to exclude from the function documentation checks

Issue - State: closed - Opened by thisisnic over 3 years ago
Labels: enhancement

#5 - Functions with no parameters should be excluded from exported function example check

Issue - State: closed - Opened by thisisnic over 3 years ago - 1 comment
Labels: enhancement

#4 - 2 vignette parse

Pull Request - State: closed - Opened by thisisnic over 3 years ago

#3 - Alternative readbility metrics

Issue - State: open - Opened by thisisnic over 3 years ago
Labels: enhancement

#2 - Scan vignettes and produce some simple metrics

Issue - State: closed - Opened by thisisnic over 3 years ago
Labels: enhancement

#1 - Add ability to check coverage of examples

Issue - State: open - Opened by thisisnic over 3 years ago
Labels: new check

GitHub / thisisnic/docreview issues and pull requests