Skip to content

Stg #49

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.

Sign up for GitHub

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

Merged
47thomasj merged 4 commits into from
Sep 12, 2025
Merged

Stg #49

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
eb58cd1
Fix missing 'Returns:' section check for functions with None return type
47thomasj Sep 12, 2025
41db2e2
Merge branch 'dev' into don't-require-None-return-docstring
47thomasj Sep 12, 2025
bbc435c
Fix missing 'Returns:' section check for functions with None return t…
47thomasj Sep 12, 2025
1cb7f4d
Dev (#48)
47thomasj Sep 12, 2025
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
2 changes: 1 addition & 1 deletion checkers/common_nodes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -338,7 +338,7 @@ def _check_missing_returns_section(node: ast.FunctionDef | ast.AsyncFunctionDef,
list containing a style error if the Returns section is missing, or empty list otherwise
"""
errors = []
if not _has_return_or_yield_section(docstring):
if not _has_return_or_yield_section(docstring) and not (isinstance(node.returns, ast.Constant) and node.returns.value is None):
error = error_creation_module.create_error(node, 'D307', f"Function '{node.name}' missing 'Returns:' or 'Yields:' section in docstring", file_path, ignore_codes)
if error:
errors.append(error)
Expand Down
Loading