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] Allow ignoring one line docstrings for DOC rules #13302

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

augustelalande
Copy link
Contributor

Summary

Add a setting to allow ignoring one line docstrings for the pydoclint rules.

Resolves #13086

Part of #12434

Test Plan

Run tests with setting enabled.

@augustelalande augustelalande changed the title [pydoclint] Allow ignoring one line docstrings in for DOC rules [pydoclint] Allow ignoring one line docstrings for DOC rules Sep 10, 2024
Copy link
Contributor

ruff-ecosystem results

Linter (stable)

✅ ecosystem check detected no linter changes.

Linter (preview)

✅ ecosystem check detected no linter changes.

Copy link
Member

@AlexWaygood AlexWaygood left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See my question in #13086 (comment) -- I'm not fully sure I understand why this option is desirable yet

@AlexWaygood AlexWaygood added configuration Related to settings and configuration docstring Related to docstring linting or formatting labels Sep 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
configuration Related to settings and configuration docstring Related to docstring linting or formatting
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Allow short docstrings in pydoclint
2 participants