python - Python docstring重复参数描述

Question

我正在开发一个 python 模块，但我遇到了问题，因为我复制并粘贴了文档。

这是一个简单的函数，但我有多个函数，其中文档字符串中的参数定义是相同的。请参见下面的示例。

def method1(common_param: str, param_coffee):
    """
    This method make coffee.

    :param  common_param:  The same parameter description
    :param  param_coffee:  Specific coffee parameter
    """
    ...

def method2(common_param: str, param_tea):
    """
    This method make tea.

    :param  common_param:  The same parameter description
    :param     param_tea:  Specific tea parameter
    """
    ...

我主要编写文档，因为当你用鼠标悬停函数时它会显示在 PyCharm 上。不幸的是，当我链接参数描述时，这个 IDE 并没有去寻找正确的解释。

参数定义不正确的 PyCharm 屏幕截图

是否可以链接它们而不是复制和粘贴参数描述？
它是否有避免在 Python 中重复参数描述的约定？
也许有类似的东西:see @method1.param.common_param:

标签： pythondocumentationdocstring