列表的正确 Google 文档字符串

Question

我一直在使用此处描述的 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
    """
    ...