Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/pyproject/_shared/latest--partial-dfc.json
Parent schema pyproject
Type: object

Properties

allow_undefined_sections boolean

Allow sections not defined in the configuration.

Default: false
require_docstrings boolean

Require docstrings for all functions/methods.

Default: true
check_private boolean

Check docstrings for private members (starting with an underscore).

Default: false
validate_param_types boolean

Validate that parameter types are provided in the docstring.

Default: true
optional_style string

The style for reporting issues in optional sections.

Default: "validate"
Values: "silent" "validate" "strict"
sections object[]

List of docstring section configurations.