ruff/crates/ruff_linter/resources/test/fixtures/pydoclint/DOC403_numpy.py
Tom Kuson bf620dcb38
[pydoclint] Permit yielding None in DOC402 and DOC403 (#13148)
Co-authored-by: Alex Waygood <alex.waygood@gmail.com>
2024-09-01 02:03:39 +01:00

113 lines
1.3 KiB
Python

# OK
def foo(num: int) -> str:
"""
Do something
Parameters
----------
num : int
A number
"""
print('test')
# DOC403
def foo(num: int) -> str:
"""
Do something
Parameters
----------
num : int
A number
Yields
-------
str
A string
"""
print('test')
class Bar:
# DOC403
def foo(self) -> str:
"""
Do something
Parameters
----------
num : int
A number
Yields
-------
str
A string
"""
print('test')
# OK
def bar(self) -> str:
"""
Do something
Parameters
----------
num : int
A number
"""
print('test')
import typing
# OK
def foo() -> typing.Generator[None, None, None]:
"""
Do something
Yields
------
When X.
"""
yield None
# OK
def foo() -> typing.Generator[None, None, None]:
"""
Do something
Yields
------
When X.
"""
yield
# OK
def foo():
"""
Do something
Yields
------
When X.
"""
yield None
# OK
def foo():
"""
Do something
Yields
------
When X.
"""
yield