文章/答案/技术大牛

发布

社区首页 >问答首页 >Flake8的"# noqa“干扰使用mkdocstring的标记。

问Flake8的"# noqa“干扰使用mkdocstring的标记。
EN

Stack Overflow用户

提问于 2022-10-17 09:48:14

回答 1查看 29关注 0票数 1

我正在使用mkdocstrings，以便从我的Python函数自动生成一个API文档。同时，我正在使用flake8来保持代码的良好状态。

如果您想在内联的基础上忽略一些flake8警告，可以插入"# noqa“，这样flake8将忽略以下代码行。

不过，这很好，"# noqa“将被mkdocstrings解释为一个标记头。

现在，我想知道如何解决flake8和mkdocstrings之间的冲突

回答已采纳

发布于 2022-10-17 12:49:43

将noqa注释放在docstring的末尾--它将应用于docstring中的任何行，而不更改字符串的内容(注意:您需要一个足够新的flake8，此更改相对较新(可能是>=4.x))

def f():
    """some docstring here

    something which causes a warning
    """  # noqa: ABC123

免责声明:我是目前的flake8维护者

票数 1

页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持

原文链接：

https://stackoverflow.com/questions/74095402

复制

相似问题

问Flake8的"# noqa“干扰使用mkdocstring的标记。EN