为了举例说明,假设我有一个函数,它以两个numpy数组作为输入参数。第一个数组必须是二维的,且只包含浮点数。第二个数组必须是一维的,且只包含布尔值。
到目前为止,我还没有找到一种现有的约定来指定函数输入数组的数据类型和维度。我想到的一种可能的格式(以numpy文档字符串约定为基础)是这样的:
到目前为止,我还没有找到一种现有的约定来指定函数输入数组的数据类型和维度。我想到的一种可能的格式(以numpy文档字符串约定为基础)是这样的:
def example_function(arr1, arr2):
"""This is an example function.
Parameters
----------
arr1 : ndarray(dtype=float, ndim=2)
Array containing some kind of data.
arr2 : ndarray(dtype=bool, ndim=1)
Array containing some kind of mask.
"""
这是否可以被视为“正确”的文档字符串格式?(即它是否不违反现有文档字符串约定的任何规则?)