python - 使用 pylint 文档参数时减少 Python 文档字符串中的冗余

标签 python pylint docstring

我正在编写一些 Python 代码,这些代码正在使用 pylint 和 docparams 检查扩大。这需要在文档字符串中记录函数参数。我倾向于尝试 decompose functions尽可能多,最后得到很多 functions that call other functions - 经常共享许多相同的参数。这可能会导致文档字符串中出现大量冗余(复制粘贴)文档。是否有推荐的处理此类情况的方法?

最佳答案

我稍后在开发 Pyramid 应用程序时会遇到同样的问题,所以我用谷歌搜索并找到了 docrep .我认为它会满足我们双方的需求。

关于python - 使用 pylint 文档参数时减少 Python 文档字符串中的冗余,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/50649830/

相关文章:

python - 使用 VS Code Python 扩展 - 如何将 python 模块安装到虚拟环境之外的永久位置?

python - 避免遍历 Pandas 中的每一行以进行自定义聚合

python - 在 Python 中转录音频文件

python - 开始使用 Pylint for Jython (jython2.5.1)

python - 如何防止 python pylint 提示套接字类 sendall 方法

python - 类中派生类中预期方法的断言和文档

python-3.x - LazyDocs - 生成的 *.md 文件不代表项目符号列表

python - 如何在文档字符串中正确显示 Pytorch 的数学符号?

python - 从 python 的覆盖范围中排除单元测试

python - 使用 python 子进程运行 GNU 并行命令