我目前正在使用 Sphinx 记录我的 Python 项目。在文档字符串的多行部分包含项目符号列表时，我遇到了一个问题。
我想包括一个项目符号列表，但其中一项很长。我愿意:
- 通过 Sphinx 正确呈现项目符号列表
- 还有关于行长 (<79) 的 PEP8 代码
对于这个文档字符串，你会建议我做什么:
class geography():
""" Class defining a geography (cities and distance matrix)
This class implements a geography with a list of named cities with their
associated coordinates in a plane. Helper functions enable to :
- give a visual representation of that geography
- give a visual representation of the distance matrix
- give a visual representation of a configuration, a configuration being the repartition of some or all cities in pools
...
最后一行超过 79 个字符。
然后通过 Sphinx 呈现评论。添加回车只会破坏 Sphinx 中的项目符号列表。
最佳答案
您可以 break the bulleted随心所欲。只需将延续与前几行文本对齐，例如:
- give a visual representation of that geography
- give a visual representation of the distance matrix
- give a visual representation of a configuration, a configuration being the
repartition of some or all cities in pools
关于 python 和狮身人面像 : bullet point list in multiline google style docstring，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/54677795/