在python docstring中编写默认值的标准方法是什么？

Question

我有一个参数设置为默认值的函数。我使用的是Numpy-stytle文档字符串，但我已经看到了其他地方写的默认值。写作的普遍接受的位置是什么＆＃34;默认＆＃34;在docstring？

def some_func(a_num=None, a_string=None):
    ''' A function that does something special.

    Parameters
    ==========
    a_num : int, default 100                        # is it written here?
        An important number.
    a_string : str, default 'foo'
        A useful string.  Default is 'foo'.         # or here?    

    '''

Answer 1

如果您在链接的文档中进一步阅读，则看起来没有一种标准样式：

  

可选关键字参数具有默认值，这些默认值显示为功能签名的一部分。它们也可以在描述中详细说明：

     

Description of parameter `x` (the default is -1, which implies summation over all axes).

     

当一个参数只能假设一组固定的值时，这些值可以用大括号列出，默认显示为：

     

order : {'C', 'F', 'A'} Description of `order`.

我建议为自己的项目选择一种风格并坚持下去。