AnswerDotAI / AnswerDotAI/nbdev
Feature request: support Numpy Docstrings fully (e.g. Notes) or google docstring styles
- Vorherrschende Sprache
- Jupyter Notebook
- Sterne
- 5.3k
- Forks
- 514
- Ø Merge
- 2 T. 30 Min.
- Gemergte PRs (30 T.)
- 8
Beschreibung
```
/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
Beitragsleitfaden
Rechercherichtung
Beginne mit fastcore/docscrape.py ungefähr bei Zeile 225 und untersuche, wie nbdev die Docstrings von class __init__ liest, insbesondere bei Vererbung. Vergleiche den angeforderten Abschnitt Notes und den Google-Docstring-Stil mit dem verlinkten Google-Leitfaden; die Aufgabe ist abgeschlossen, wenn die unterstützten Docstring-Abschnitte und das Vererbungsverhalten definiert und ohne die Warnung behandelt werden.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- documentation
- Issue-Typ
- Feature
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Aktivitätsstatus
- Veraltet
- Klarheit
- Muss geklärt werden
- Anfängerfreundlichkeit
- 25/100