未文档化的公共模块 (D100)
源自 pydocstyle 代码检查器。
作用
检查未文档化的公共模块定义。
为什么这不好？
公共模块应该通过文档字符串进行文档化，以概述其目的和内容。
一般来说，模块文档字符串应该描述模块的目的，并列出模块导出的类、异常、函数和其他对象，以及每个对象的一行摘要。
如果模块是一个脚本，文档字符串应该可以用作其“用法”消息。
如果代码库遵循模块文档字符串的标准格式，请遵循该格式以保持一致性。
示例
class FasterThanLightError(ZeroDivisionError): ...
def calculate_speed(distance: float, time: float) -> float: ...
建议改为
"""Utility functions and classes for calculating speed.
This module provides:
- FasterThanLightError: exception when FTL speed is calculated;
- calculate_speed: calculate speed given distance and time.
"""
class FasterThanLightError(ZeroDivisionError): ...
def calculate_speed(distance: float, time: float) -> float: ...
Notebook 行为
此规则对于 Jupyter Notebooks 将被忽略。