Skip to content

Commit

Permalink
Force multiline docstrings to start on the second line (#3524)
Browse files Browse the repository at this point in the history
We enable all D* checks, but our selected convention disables some of
them again. Adding D213 to the list of enabled checks does the trick.

This will not affect singleline docstrings :/
  • Loading branch information
happz authored Feb 13, 2025
1 parent 3dd836b commit 254b9e6
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 1 deletion.
2 changes: 2 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -340,6 +340,8 @@ select = [
"FURB", # refurb
"RUF", # ruff
"D", # pydocstyle
# Override docstring convention
"D213", # multi-line-summary-second-line
]
ignore = [
"B904", # Within an `except` clause, raise exceptions with `raise ... from err` or `raise ...
Expand Down
3 changes: 2 additions & 1 deletion tmt/options.py
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,8 @@ def convert(
param: Optional[click.Parameter],
ctx: Optional[click.Context],
) -> Optional[tmt.utils.Path]:
"""Convert the value to the correct type. This is not called if
"""
Convert the value to the correct type. This is not called if
the value is ``None`` (the missing value).
This must accept string values from the command line, as well as
Expand Down

0 comments on commit 254b9e6

Please sign in to comment.