AnswerDotAI / AnswerDotAI/nbdev

showdoc only shows first returned object for numpy docstrings

Open
#1,457 0 comments 0 reactions 0 assignees View on GitHub
bug
Dominant language
Jupyter Notebook
Stars
5.3k
Forks
513
Avg merge
2d 30m
Merged PRs (30d)
8

Description

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".

Contributor guide

Open the contributing guide

Research direction

Start by tracing how nbdev.showdoc and nbdev_preview parse the NumPy-style Returns section, using the provided function as a reproduction case. Done means the generated documentation mentions both returned objects, “a” and “b,” rather than only the first.

Written by the indexing model from the issue text.

Assessment

Tech stack
jupyter, numpy, python
Domain
documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.