LintTable

pydantic model technote.sources.tomlsettings.LintTable

The [technote.lint] table configures technote linting.

Technote itself does not run lint rules; the rules are implemented by tools that build on technote (currently Documenteer’s technote lint command). This table is owned by technote so that every tool reads the same configuration from technote.toml, and so that the schema does not carry a specific tool’s name.

Parameters:

data (Any)

Show JSON schema

{
   "title": "LintTable",
   "description": "The ``[technote.lint]`` table configures technote linting.\n\nTechnote itself does not run lint rules; the rules are implemented by\ntools that build on technote (currently Documenteer's ``technote lint``\ncommand). This table is owned by technote so that every tool reads the\nsame configuration from ``technote.toml``, and so that the schema does\nnot carry a specific tool's name.",
   "type": "object",
   "properties": {
      "ignore": {
         "description": "Codes of lint rules to skip for this technote, such as ``\"TN105\"``. A code is an uppercase prefix naming the rule set followed by a number.",
         "examples": [
            [
               "TN105",
               "R101"
            ]
         ],
         "items": {
            "type": "string"
         },
         "title": "Ignore",
         "type": "array"
      }
   }
}

Fields:

• ignore (list[str])

Validators:

• validate_rule_codes » ignore

field ignore: list[str] [Optional]

Codes of lint rules to skip for this technote, such as "TN105". A code is an uppercase prefix naming the rule set followed by a number.

Validated by:

• validate_rule_codes

validator validate_rule_codes  »  ignore

Ensure that each ignored rule code has the shape of a rule code: an uppercase prefix followed by a number.

The rule codes themselves are not known to technote, so only the shape is validated.

Parameters:

v (list[str])

Return type:

list[str]