我有一些辅助函数,除了第一个参数外,其余参数与核心函数相同。这些参数在核心函数中得到了详细的文档说明。我应该将这些文档复制粘贴到辅助函数中,还是只需指向核心文档即可?
如果有所影响,我主要打算将我的API参考作为由Sphinx生成的HTML阅读,并使用numpydoc风格。我没有在numpydoc手册中找到答案。
编辑
这里是一个最小化工作示例(MWE):
正如您所看到的,这两个函数中只有第一个参数不同。
如果有所影响,我主要打算将我的API参考作为由Sphinx生成的HTML阅读,并使用numpydoc风格。我没有在numpydoc手册中找到答案。
编辑
这里是一个最小化工作示例(MWE):
def core(param0, param1=3, param2=8):
"""Core function with thorough documentation.
Parameters
----------
param0 : ndarray
Description.
param1 : int
Long description.
param2 : int
Long description.
Returns
-------
param_out : ndarray
Long description
"""
pass
def helper(param3, param1=3, param2=8):
"""Helper function.
"""
pass
正如您所看到的,这两个函数中只有第一个参数不同。