-
Notifications
You must be signed in to change notification settings - Fork 2
Open
Labels
area-doc-genIssues relating to documentation extraction and generationIssues relating to documentation extraction and generationarea-lintersIssues relating to linters and code fixersIssues relating to linters and code fixersenhancementNew feature or requestNew feature or request
Description
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.
Metadata
Metadata
Assignees
Labels
area-doc-genIssues relating to documentation extraction and generationIssues relating to documentation extraction and generationarea-lintersIssues relating to linters and code fixersIssues relating to linters and code fixersenhancementNew feature or requestNew feature or request