列表的正确 Google 文档字符串

Question

我一直在使用 Google here 描述的文档字符串格式，但我想知道是否有一种公认的方法来记录已知类型的列表。

我一直在用

def function(a_list)
    """

    Args:
        a_list (list[dict]): a list of dictionaries
    """
    ...

这是正确的吗？

Answer 1

考虑到在我第一次问这个问题时不存在的类型提示方面的进步，我现在会遵从那种风格：

from typing import List

def function(a_list: List[dict])
    """

    Args:
        a_list (List[dict]): a list of dictionaries
    """
    ...