Skip to content

Commit

Permalink
chore: add docstring lints
Browse files Browse the repository at this point in the history
  • Loading branch information
msto committed Oct 21, 2024
1 parent 318ff98 commit af18754
Showing 1 changed file with 20 additions and 2 deletions.
22 changes: 20 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,26 @@ target-version = "py38"
output-format = "full"

[tool.ruff.lint]
select = ["C901", "B", "E", "F", "I", "W", "Q"]
ignore = ["E203", "E701"]
select = [
"C901",
"B",
"D", # pydocstyle (docstrings. We have the "google" convention enabled)
"D204", # Blank line between class docstring and first (__init__) method
"D213", # Summary line should be located on the line after opening quotes
"D401", # Summary line should be in imperative tense.
"E",
"F",
"I",
"W",
"Q"
]
ignore = [
"E203",
"E701",
"D212", # summary line should be located on the same line as opening quotes
"D100", # missing docstring in public module
"D104", # missing docstring in public package
]
unfixable = ["B"]

[tool.ruff.lint.isort]
Expand Down

0 comments on commit af18754

Please sign in to comment.