Skip to content

Use isgeneratorfunction to avoid false alarm YD01 validation #368

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
merged 1 commit into from
Mar 15, 2022
Merged

Use isgeneratorfunction to avoid false alarm YD01 validation #368

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 5 additions & 1 deletion numpydoc/validate.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -178,6 +178,10 @@ def type(self):
def is_function_or_method(self):
return inspect.isfunction(self.obj)

@property
def is_generator_function(self):
return inspect.isgeneratorfunction(self.obj)

@property
def source_file_name(self):
"""
Expand Down Expand Up @@ -596,7 +600,7 @@ def validate(obj_name):
for name_or_type, type_, desc in doc.returns:
errs.extend(_check_desc(desc, "RT03", "RT04", "RT05"))

if not doc.yields and "yield" in doc.method_source:
if not doc.yields and doc.is_generator_function:
errs.append(error("YD01"))

if not doc.see_also:
Expand Down