Skip to content

Commit 9b7ada8

Browse files
authored
Use isgeneratorfunction to avoid overgenerating YD01 (#368)
Fixes #365
1 parent f33a53e commit 9b7ada8

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

numpydoc/validate.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -178,6 +178,10 @@ def type(self):
178178
def is_function_or_method(self):
179179
return inspect.isfunction(self.obj)
180180

181+
@property
182+
def is_generator_function(self):
183+
return inspect.isgeneratorfunction(self.obj)
184+
181185
@property
182186
def source_file_name(self):
183187
"""
@@ -596,7 +600,7 @@ def validate(obj_name):
596600
for name_or_type, type_, desc in doc.returns:
597601
errs.extend(_check_desc(desc, "RT03", "RT04", "RT05"))
598602

599-
if not doc.yields and "yield" in doc.method_source:
603+
if not doc.yields and doc.is_generator_function:
600604
errs.append(error("YD01"))
601605

602606
if not doc.see_also:

0 commit comments

Comments
 (0)