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

Question

我希望我就在这里channel/tag。

我正在使用 lazydocs 自动生成我的 md 文件。 我的项目是用Python3.7.5.

写的

我的文档字符串中确实有一些项目符号列表。 根据这个 example 我需要留下一个空行，然后是 4 个空格，例如"-" 紧随其后，项目符号列表的结尾是另一个空行。

举个例子：

"""This is my example docstring

A simple bullet list:

    - point 1
    - point 2
    - point 3

"""

但是当我使用 lazydocs 生成我的 md 文件时，md 文件看起来像：

This is my example docstring

A simple bullet list:

    - point 1    - point 2    - point 3

我希望我的 md 文件看起来像

This is my example docstring

A simple bullet list:

    - point 1
    - point 2
    - point 3

然后我试了一下。我发现在项目符号项之间留一个空行会使 lazydocs 以预期的格式生成我的 md5 文件。 看起来像这样：

"""This is my example docstring

A simple bullet list:

    - point 1

    - point 2

    - point 3

"""

但是我想在我的代码中插入空行并不是记录我的代码的好方法:)

所以我的问题是：

我是不是做错了什么，还是lazydocs没有正确处理要点？

非常感谢您的帮助！

Answer 1

我们刚刚发布了支持项目符号列表的新版本 lazydocs (0.4.4)。您可以通过以下方式升级：

pip install --upgrade lazydocs

在此版本的 lazydocs 中使用项目符号列表的正确方法是不缩进：

"""This is my example docstring

A simple bullet list:

- point 1
- point 2
- point 3

"""