nbdev icon indicating copy to clipboard operation
nbdev copied to clipboard

showdoc only shows first returned object for numpy docstrings

Open nikolas-claussen opened this issue 4 months ago • 0 comments

For a function that returns multiple objects, parsing a numpy-style doctring with nbdev.showdoc (and nbdev_preview in the command window) only shows the first returned object. Example:

def f(x):
    """
   foo

    Parameters
    ----------
    x : int
    
    Returns
    -------
    a : int
    b : str

    """
    return a, b

This gives a docstring that only mentions "a" and not "b".

nikolas-claussen avatar Oct 02 '24 00:10 nikolas-claussen