用于列表的正确Google文档字符串

Question

我一直使用here所述的Google Docstring格式，但我想知道是否存在用于记录已知类型列表的商定方法。

我一直在使用

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
    """
    ...