lp-lint-doctest 0.5

lp-lint-doctest 是一个用于存储在文本文件中（与存储在docstrings中的doctests相对）的 Python doctests 的样式检查器，优化用于 Launchpad开发。它执行以下检查

• 注释应位于doctest的叙述部分（即未缩进的文本）而不是Python示例中。

• 叙述文本行限制为79个字符。

• 示例中的源行（以>>> 或 ... 开头）限制为71个字符。

• 示例中的预期输出行限制为75个字符。

• 源和预期输出行应缩进四个空格。

• 不应有尾随空格。

• 应使用reStructuredText风格的标题，而不是MoinMoin风格。

在示例中的任何源行中添加 # noqa 注释可以抑制该示例中所有行的注释、行长度、缩进和尾随空格检查。

此外，lp-lint-doctest 对每个 doctest 文件的累积源代码运行 pyflakes。

本项目是从 Curtis Hovey 的 pocket-lint 项目中拆分出来的。自那时以来，许多其他优秀的 linters 已经出现，支持 pocket-lint 支持的大多数其他源类型，但似乎没有其他可行的替代品来替代其 doctest 检查。

lp-lint-doctest 支持 pre-commit。要使用它，请将以下内容添加到您的 .pre-commit-config.yaml 文件的 repos 部分

-   repo: https://git.launchpad.net/lp-lint-doctest
    rev: ''  # pick a git tag to point to
    hooks:
    -   id: lp-lint-doctest

如果您需要添加自定义 doctest 选项标志，请添加 args: [--allow-option-flag, MY_CUSTOM_FLAG_NAME]。