Suppose I have two functions:
def func_a(x, passed_parameter):
"""
Return ...
Args:
x: ...
passed_parameter: Do a specific thing.
"""
...
def func_b(passed_parameter):
"""
Return ...
Args:
passed_parameter: Do a specific thing.
"""
...
I think it is clear enough that this situation arises in programming, and copy-pasting is not an option for obvious reasons. My question then is, specifically for pdoc (Google-style docstrings), how do I document passed_parameter in func_a. My first thought is just writing
passed_parameter: See `func_b`.
This is fine, but I was wondering if there is a more preferred way of doing this either in pdoc, or a recommended way in a PEP. I tried something like "See func_b.passed_parameter" but this does not hyperlink to the parameter in pdoc.