Skip to content

Create tests for completeness of documentation #916

Closed
@AshesITR

Description

@AshesITR

From https://github.com/AshesITR/lintr/pull/2#discussion_r820162915

do we have a CRAN release script? we should add something that ensures this list is complete before release in case new tags are added

Yeah I thought about the possibility to add a test case, but wasn't sure if testthat would be able to reliably inspect the current package help index.

We should also check that all tags have at least one linter, that all tags listed in available_linters() are in fact documented, that all linters listed in available_linters() are exported (and documented) and all exported functions ending in _linter are in available_linters().

Even better would be to check for the Tags & Linters sections where appropriate, to ensure newly created linters have all the necessary boilerplate.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions