docstring-missing-returns (DOC201)

源自 pydoclint 代码检查器。

此规则不稳定且处于预览状态。使用需要 --preview 标志。

作用

检查具有 return 语句但其文档字符串中没有 "Returns" 部分的函数。

为什么这不好？

缺少 "Returns" 部分是不完整文档的标志。

此规则不适用于抽象方法或仅返回 None 的函数。 对于“存根函数”也会忽略它：函数体仅包含 pass、...、raise NotImplementedError 或类似内容。

示例

def calculate_speed(distance: float, time: float) -> float:
    """Calculate speed as distance divided by time.

    Args:
        distance: Distance traveled.
        time: Time spent traveling.
    """
    return distance / time

建议改为

def calculate_speed(distance: float, time: float) -> float:
    """Calculate speed as distance divided by time.

    Args:
        distance: Distance traveled.
        time: Time spent traveling.

    Returns:
        Speed as distance divided by time.
    """
    return distance / time