对于模块级函数,有没有办法自动生成经常出现的内容,即 'Returns: None' ,这样就不会在许多文档字符串中重复写入?
我已经看到了一些使用 的格式napoleon_custom_sections
,但这似乎不是我的直接用例。
例如,如果以下生成的文档包含 None Return 或对基本文档字符串的其他指定添加:
def module_level_function(param1, param2=None, *args, **kwargs):
"""This is an example of a module level function.
Args:
param1 (int): The first parameter.
param2 (Optional[str]): The second parameter. Defaults to None.
"""