pydoclint
: Disable --skip-checking-short-docstrings
by default
#215
Labels
part:cookiecutter
Affects the generation of projects using cookiecutter
part:tooling
Affects the development tooling (CI, deployment, dependency management, etc.)
type:enhancement
New feature or enhancement visitble to users
Milestone
What's needed?
We are currently enabling the --skip-checking-short-docstrings option to avoid having redundant documentation for simple methods and also properties.
As a downside, some documentation might be missing accidentally when people write a short docstring, but they really don't want to skip all the details, specially in cases where there are extra arguments.
Google coding style allows for this omission but only for
Returns
:This makes more sense and should be much safer.
Proposed solution
Disable
--skip-checking-short-docstrings
, but that would leave us with a lot of redundant documentation again.Ideally we should have much more control about how much info can be missing, but this is not yet possible with
pydoclint
. So we might need to wait until these get implemented (or try to send PRs ourselves):Returns
/Yields
if summary starts withReturn(s)/Yield(s)
jsh9/pydoclint#110@property
s as a member jsh9/pydoclint#111--skip-checking-short-docstrings
jsh9/pydoclint#112The text was updated successfully, but these errors were encountered: