Skip to content

Lint documentation examples #14

Open

Description

@SquidDev

I've had a couple of issues where examples in documentation comments have been incorrect, due to using non-existent variables, etc...

While we do ensure examples are syntactically valid Lua, we don't run any other linters. We probably should do so. We want a way to opt out of linting (though probably not the syntax check). The easiest way would probably be to allow writing lua :nolint as the language type.

One further extension would be to allow arbitrary configs in the linter (for instance, lua :illuaminate:(linters (-var:unused-arg))), but that might be a little too much.

Activity

  1. added
    enhancementNew feature or request
    area-lintersIssues relating to linters and code fixers
    area-doc-genIssues relating to documentation extraction and generation
    on Oct 8, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    area-doc-genIssues relating to documentation extraction and generationarea-lintersIssues relating to linters and code fixersenhancementNew feature or request

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions