9fb2b36228
- 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>
15 lines
814 B
INI
15 lines
814 B
INI
# Enforce Google-style docstrings while avoiding conflicts with pydoclint
|
|
[pydocstyle]
|
|
convention = google
|
|
|
|
# Ignored rules:
|
|
# D100 - Ignore missing module-level docstrings (unnecessary in structured frameworks)
|
|
# D107 - Ignore missing docstrings for __init__ methods (handled by interrogate)
|
|
# D200 - Allow multi-line docstrings instead of forcing one-liners (Google-style)
|
|
# D203 - Allow class docstrings to be directly under the class definition (Google-style)
|
|
# 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
|
|
# D415 - Do not enforce punctuation on the first line of docstrings
|
|
add-ignore = D100,D107,D200,D203,D212,D213,D301,D415
|