元组参数的文档字符串约定?



如何记录元组参数?它应该指定元组内部的类型,还是只指定它是一个元组的事实?记录它的好方法是什么?

def generate_dependency_table(head_revision, dependencies):
"""
Generate a dependency table as a bytes object.
Parameters:
dependencies ?
Returns:
dependency_table (bytes): The generated dependency table.
"""

使用类型提示(而不是文档字符串)来注释函数参数类型。

from typing import Tuple
def generate_dependency_table(head_revision: int, dependencies: Tuple[str, int]) -> bytes:

最新更新