ruff/crates/ruff_linter/resources/test/fixtures/pydoclint/DOC202_google.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

87 lines
1.2 KiB
Python

# OK
def foo(num: int) -> str:
"""
Do something
Args:
num (int): A number
"""
print('test')
# DOC202
def foo(num: int) -> str:
"""
Do something
Args:
num (int): A number
Returns:
str: A string
"""
print('test')
class Bar:
# DOC202
def foo(self) -> str:
"""
Do something
Args:
num (int): A number
Returns:
str: A string
"""
print('test')
# OK
def bar(self) -> str:
"""
Do something
Args:
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
import abc
class A(metaclass=abc.abcmeta):
@abc.abstractmethod
def f(self):
"""Lorem ipsum
Returns:
dict: The values
"""
return
# DOC202 -- never explicitly returns anything, just short-circuits
def foo(s: str, condition: bool):
"""Fooey things.
Returns:
None
"""
if not condition:
return
print(s)