AnswerDotAI / AnswerDotAI/nbdev

showdoc only shows first returned object for numpy docstrings

Aperta
#1,457 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
bug
Lingua principale
Jupyter Notebook
Stelle
5.3k
Fork
513
Merge medio
2g 30m
PR unite (30g)
8

Descrizione

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

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Inizia tracciando il modo in cui nbdev.showdoc e nbdev_preview analizzano la sezione Returns nello stile NumPy, usando la funzione fornita come caso di riproduzione. Il lavoro è completato quando la documentazione generata menziona entrambi gli oggetti restituiti, “a” e “b”, invece del solo primo.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
jupyter, numpy, python
Ambito
documentation
Tipo di issue
Bug
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
42/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.