AnswerDotAI / AnswerDotAI/nbdev

Feature request: support Numpy Docstrings fully (e.g. Notes) or google docstring styles

Aperta
#1,313 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

```
/opt/hostedtoolcache/Python/3.10.10/x64/lib/python3.10/site-packages/fastcore/docscrape.py:225: UserWarning: Unknown section Notes
```
Side note: `nbdev` doesn't use `__init__` function docstring in a class if that class has inheritance, rather it uses that base class...

https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Inizia da fastcore/docscrape.py intorno alla riga 225 e analizza come nbdev legge le docstring di class __init__, soprattutto con l’ereditarietà. Confronta la sezione Notes richiesta e lo stile delle docstring Google con la guida Google collegata; il lavoro è completo quando le sezioni di docstring supportate e il comportamento dell’ereditarietà sono definiti e gestiti senza l’avviso.

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

Valutazione

Stack tecnologico
python
Ambito
documentation
Tipo di issue
Funzionalità
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Da chiarire
Idoneità per principianti
25/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.