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

Ignore DOC errors for stub functions #12651

Merged
merged 1 commit into from
Aug 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -48,3 +48,14 @@ def bar(self) -> str:
num (int): A number
"""
print('test')


# See: https://github.com/astral-sh/ruff/issues/12650
class C:
def foo(self) -> int:
"""Calculate x.

Returns:
x
"""
raise NotImplementedError
30 changes: 16 additions & 14 deletions crates/ruff_linter/src/rules/pydoclint/rules/check_docstring.rs
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ use ruff_python_ast::helpers::map_callable;
use ruff_python_ast::name::QualifiedName;
use ruff_python_ast::visitor::Visitor;
use ruff_python_ast::{self as ast, visitor, Expr, Stmt};
use ruff_python_semantic::{Definition, MemberKind, SemanticModel};
use ruff_python_semantic::analyze::function_type;
use ruff_python_semantic::{Definition, SemanticModel};
use ruff_text_size::{Ranged, TextRange};

use crate::checkers::ast::Checker;
Expand Down Expand Up @@ -645,15 +646,14 @@ pub(crate) fn check_docstring(
convention: Option<Convention>,
) {
let mut diagnostics = Vec::new();
let Definition::Member(member) = definition else {

// Only check function docstrings.
let Some(function_def) = definition.as_function_def() else {
return;
};

// Only check function docstrings.
if matches!(
Copy link
Member

Choose a reason for hiding this comment

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

Is this check now covered by is_stub?

Copy link
Member

Choose a reason for hiding this comment

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

It's covered by the

let Some(function_def) = definition.as_function_def() else {
    return;
};

immediately above

member.kind,
MemberKind::Class(_) | MemberKind::NestedClass(_)
) {
// Ignore stubs.
if function_type::is_stub(function_def, checker.semantic()) {
return;
}

Expand All @@ -670,17 +670,19 @@ pub(crate) fn check_docstring(

let body_entries = {
let mut visitor = BodyVisitor::new(checker.semantic());
visitor.visit_body(member.body());
visitor.visit_body(&function_def.body);
visitor.finish()
};

// DOC201
if checker.enabled(Rule::DocstringMissingReturns) && docstring_sections.returns.is_none() {
let extra_property_decorators = checker.settings.pydocstyle.property_decorators();
if !definition.is_property(extra_property_decorators, checker.semantic()) {
if let Some(body_return) = body_entries.returns.first() {
let diagnostic = Diagnostic::new(DocstringMissingReturns, body_return.range());
diagnostics.push(diagnostic);
if checker.enabled(Rule::DocstringMissingReturns) {
Copy link
Member

Choose a reason for hiding this comment

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

Is this change just a stylistic preference?

Copy link
Member Author

Choose a reason for hiding this comment

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

Yeah, I prefer to have the enablement checks separated out from any lint-specific checks. I find it to be a clearer separation, and it would make it easier to identify and automatically rewrite them in the future.

Copy link
Member

Choose a reason for hiding this comment

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

Makes sense, thanks

if docstring_sections.returns.is_none() {
let extra_property_decorators = checker.settings.pydocstyle.property_decorators();
if !definition.is_property(extra_property_decorators, checker.semantic()) {
if let Some(body_return) = body_entries.returns.first() {
let diagnostic = Diagnostic::new(DocstringMissingReturns, body_return.range());
diagnostics.push(diagnostic);
}
}
}
}
Expand Down
Loading