starlingx/test
Code Issues Proposed changes

Merge "Relax docstring constraints"

Browse Source
This commit is contained in:
Zuul
2025-02-26 14:19:38 +00:00
committed by Gerrit Code Review
parent 48a2ba888f 9fb2b36228
commit d9fd0abce4
2 changed files with 3 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
pydocstyle.ini
View File

@@ -10,4 +10,5 @@ convention = google
# D212 - Allow function/method docstring summaries to start on the second line (Google-style)
# D213 - Allow class docstring summaries to start on the first line (Google-style)
# D301 - Use r""" if any backslashes in a docstring
add-ignore = D100,D107,D200,D203,D212,D213,D301
# D415 - Do not enforce punctuation on the first line of docstrings
add-ignore = D100,D107,D200,D203,D212,D213,D301,D415

1
pyproject.toml
View File

@@ -12,3 +12,4 @@ line-length = 9999 # Prevents Black from arbitrarily wrapping lines
style = "google"
check-return-types = true
allow-init-docstring = true
ignore = ["DOC501"] # Ignore Raises section requirement