Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

pydoclint: Disable --skip-checking-short-docstrings by default #215

Open
1 of 3 tasks
llucax opened this issue Jan 8, 2024 · 1 comment
Open
1 of 3 tasks

pydoclint: Disable --skip-checking-short-docstrings by default #215

llucax opened this issue Jan 8, 2024 · 1 comment
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

Comments

@llucax
Copy link
Contributor

llucax commented Jan 8, 2024

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:

It may also be omitted if the docstring starts with Returns or Yields (e.g. """Returns row from Bigtable as a tuple of strings.""") and the opening sentence is sufficient to describe the return value.

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):

@llucax llucax added part:tooling Affects the development tooling (CI, deployment, dependency management, etc.) type:enhancement New feature or enhancement visitble to users part:cookiecutter Affects the generation of projects using cookiecutter labels Jan 8, 2024
@llucax llucax added this to the v0.12.0 milestone Jan 8, 2024
@llucax
Copy link
Contributor Author

llucax commented Jan 8, 2024

@shsms FYI

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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
Projects
None yet
Development

No branches or pull requests

1 participant