Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

showdoc only shows first returned object for numpy docstrings #1457

Open
nikolas-claussen opened this issue Oct 2, 2024 · 0 comments
Open
Labels
bug Something isn't working

Comments

@nikolas-claussen
Copy link

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 nikolas-claussen added the bug Something isn't working label Oct 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

1 participant