Man pages for thisisnic/docreview
Opinionated Documentation Checking
| analyse_rds | Get exports which don't have any examples |
| analyse_vignette | Analyse a single vignette |
| check_image_alt_text | Check each image for an alt text description |
| check_results | Check results and raise error if necessary |
| clean_chunks | Clean markdown chunks |
| divide_by_section | Divide by section |
| find_exported_functions | Get exports |
| find_vignettes | Find vignettes |
| function_get_comments | Count failures and warnings for function review |
| function_results_display | Parse function documentation analysis results |
| function_review | Review functions |
| get_config | Set config for docreview checks |
| get_fk_score | Get Flesch-Kincaid readability score |
| get_length | Get number of words in a markdown chunk |
| package_review | Review package documentation |
| parse_vignette | Parse a vignette |
| remove_bullets | Remove bullet points from a chunk |
| remove_code | Remove any code in backticks from a chunk |
| remove_links | Remove links from a chunk |
| remove_pipe_tables | Remove pipe table from a chunk |
| vignette_results_display | Parse Vignette Results |
| vignette_review | Review vignettes |
