starlingx/test
Code Issues Proposed changes

Relax docstring constraints

Browse Source 
- Ignore `DOC501` in `pydoclint` to avoid requiring "Raises" sections
  for all functions that raise exceptions.
- Ignore `D415` in `pydocstyle` to allow first-line summaries without
  strict punctuation enforcement.

Depends-On: https://review.opendev.org/c/starlingx/test/+/942742
Change-Id: Ib01e8a0af25e1b7783179e1af26f56e87fe00aa0
Signed-off-by: Andrew Vaillancourt <andrew.vaillancourt@windriver.com>
This commit is contained in:
Andrew Vaillancourt 2025-02-25 20:01:20 -05:00
parent 0d87c270d9
commit 9fb2b36228
2 changed files with 3 additions and 1 deletions
Show Stats 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

@ -11,3 +11,4 @@ include = '\.py'
style = "google"
check-return-types = true
allow-init-docstring = true
ignore = ["DOC501"] # Ignore Raises section requirement