在Python文档字符串中追踪白线的目的是什么?

时间:2017-08-09 10:29:22

标签: python standards docstring

我在Python文档字符串的末尾看到了一条尾随的白线(例如in Numpy docstringsin Google style docstrings,我记得曾在某处读到过这样的建议。

也就是说,它们似乎在docstring转换器中被忽略,例如in Napolean和示例例程in the PEP-257 docs。

在Python文档字符串中添加尾部白线的目的是什么?它纯粹是为了易读吗?

1 个答案:

答案 0 :(得分:5)

以前是PEP257推荐的,因此可以方便地使用编辑器段落包装命令。但三年前该建议已被删除:https://github.com/python/peps/commit/ab85e78f9b2a06c8c2b7866e0577787f21346fd5