Skip to content

Don't enforce returns and yields in abstract methods#12771

Merged
charliermarsh merged 1 commit intomainfrom
charlie/abs
Aug 9, 2024
Merged

Don't enforce returns and yields in abstract methods#12771
charliermarsh merged 1 commit intomainfrom
charlie/abs

Conversation

@charliermarsh
Copy link
Copy Markdown
Member

Summary

Closes #12685.

@charliermarsh charliermarsh added bug Something isn't working docstring Related to docstring linting or formatting labels Aug 9, 2024
Comment thread crates/ruff_linter/src/rules/pydoclint/rules/check_docstring.rs Outdated
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Aug 9, 2024

ruff-ecosystem results

Linter (stable)

✅ ecosystem check detected no linter changes.

Linter (preview)

✅ ecosystem check detected no linter changes.

@charliermarsh charliermarsh enabled auto-merge (squash) August 9, 2024 13:29
@charliermarsh charliermarsh merged commit 1f51048 into main Aug 9, 2024
@charliermarsh charliermarsh deleted the charlie/abs branch August 9, 2024 13:34
/// Docstrings missing return sections are a sign of incomplete documentation
/// or refactors.
///
/// This rule is not enforced for abstract methods and stubs functions.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
/// This rule is not enforced for abstract methods and stubs functions.
/// This rule is not enforced for stub functions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working docstring Related to docstring linting or formatting

Projects

None yet

Development

Successfully merging this pull request may close these issues.

DOC202 false positive with abstract methods

3 participants