Python 2.7 适合列表的Google文档字符串
我一直在使用上面描述的GoogleDocstring格式,但我想知道是否有一种公认的方法来记录已知类型的列表 我一直在用Python 2.7 适合列表的Google文档字符串,python-2.7,docstring,Python 2.7,Docstring,我一直在使用上面描述的GoogleDocstring格式,但我想知道是否有一种公认的方法来记录已知类型的列表 我一直在用 def function(a_list) """ Args: a_list (list[dict]): a list of dictionaries """ ... 这是正确的吗?考虑到我第一次问这个问题时在类型暗示方面所取得的进步,我现在将遵循这种风格: from typing import List def funct
def function(a_list)
"""
Args:
a_list (list[dict]): a list of dictionaries
"""
...
这是正确的吗?考虑到我第一次问这个问题时在类型暗示方面所取得的进步,我现在将遵循这种风格:
from typing import List
def function(a_list: List[dict])
"""
Args:
a_list (List[dict]): a list of dictionaries
"""
...
我不知道这种特定的格式,但表示列表的常用方法是
键入[]
。值得一提的是,它看起来不像是真正的谷歌风格指南鼓励使用这种格式的类型,而只是简单的英文类型指示