How to handle doc strings

[jlapeyre]

How do doc strings work with several methods? It would be nice to put different doc strings in different methods. I don't think this works.

Is there a recommended way then ? Maybe put one big doc string in the first method?

[wesselb]

Hey @jlapeyre!

Currently, the docstring of the first definition of a function is used. Example:

from plum import dispatch


@dispatch
def f(x: str):
    """Do something."""
    pass


@dispatch
def f(x: int):
    """Do more."""
    pass


print(f.__doc__)  # "Do something."

Ideally, all docstrings would be appended in some sane way. E.g., for the above example, f.__doc__ would ideally be

f(x: str)

Do something.

—

f(x: int)

Do more.

I've tagged this issue as a feature request. I think this would be a nice improvement!