mirror of
https://github.com/astral-sh/ruff.git
synced 2025-07-07 21:25:24 +00:00
4bc73dd87e
## Summary These are the first rules implemented as part of #458, but I plan to implement more. Specifically, this implements `docstring-missing-exception` which checks for raised exceptions not documented in the docstring, and `docstring-extraneous-exception` which checks for exceptions in the docstring not present in the body. ## Test Plan Test fixtures added for both google and numpy style.
84 lines
1.6 KiB
Python
84 lines
1.6 KiB
Python
class FasterThanLightError(Exception):
|
|
...
|
|
|
|
|
|
# DOC502
|
|
def calculate_speed(distance: float, time: float) -> float:
|
|
"""
|
|
Calculate speed as distance divided by time.
|
|
|
|
Parameters
|
|
----------
|
|
distance : float
|
|
Distance traveled.
|
|
time : float
|
|
Time spent traveling.
|
|
|
|
Returns
|
|
-------
|
|
float
|
|
Speed as distance divided by time.
|
|
|
|
Raises
|
|
------
|
|
FasterThanLightError
|
|
If speed is greater than the speed of light.
|
|
"""
|
|
return distance / time
|
|
|
|
|
|
# DOC502
|
|
def calculate_speed(distance: float, time: float) -> float:
|
|
"""
|
|
Calculate speed as distance divided by time.
|
|
|
|
Parameters
|
|
----------
|
|
distance : float
|
|
Distance traveled.
|
|
time : float
|
|
Time spent traveling.
|
|
|
|
Returns
|
|
-------
|
|
float
|
|
Speed as distance divided by time.
|
|
|
|
Raises
|
|
------
|
|
FasterThanLightError
|
|
If speed is greater than the speed of light.
|
|
DivisionByZero
|
|
If attempting to divide by zero.
|
|
"""
|
|
return distance / time
|
|
|
|
|
|
# DOC502
|
|
def calculate_speed(distance: float, time: float) -> float:
|
|
"""
|
|
Calculate speed as distance divided by time.
|
|
|
|
Parameters
|
|
----------
|
|
distance : float
|
|
Distance traveled.
|
|
time : float
|
|
Time spent traveling.
|
|
|
|
Returns
|
|
-------
|
|
float
|
|
Speed as distance divided by time.
|
|
|
|
Raises
|
|
------
|
|
FasterThanLightError
|
|
If speed is greater than the speed of light.
|
|
DivisionByZero
|
|
If attempting to divide by zero.
|
|
"""
|
|
try:
|
|
return distance / time
|
|
except ZeroDivisionError as exc:
|
|
raise FasterThanLightError from exc
|