[tool.ruff.lint]
select = [
"D", # pydocstyle
"F", "E", "W", # flake8
"PL", # pylint
"S", # bandit
"I", # isort
]
ignore = [
# warning: `one-blank-line-before-class` (D203) and `no-blank-line-before-class` (D211) are incompatible.
"D203", # 1 blank line required before class docstring
# D212 is enabled by default in google convention, and complains if we have a docstring like:
# """
# My docstring is on the line after the opening quotes instead of on the same line as them.
# """
# We've discussed and concluded that we consider this to be a valid style choice.
"D212", # Multi-line docstring summary should start at the first line
"D213", # Multi-line docstring summary should start at the second line
# Produces a lot of issues in the current codebase.
"D401", # First line of docstring should be in imperative mood
"D407", # Missing dashed underline after section
"D416", # Section name ends in colon
"E501", # Line too long
]
[tool.ruff.lint.pydocstyle]
convention = "google"
[tool.ruff.lint.per-file-ignores]
"{{ cookiecutter.app_name }}/migrations/*" = [
"D",
]
"{{ cookiecutter.app_name }}/tests/*" = [
"D",
"S"
]
Example -- nautobot core ruff settings:
Cookie ruff settings: