AnswerDotAI / AnswerDotAI/nbdev
Render docs for methods by default
- Vorherrschende Sprache
- Jupyter Notebook
- Sterne
- 5.3k
- Forks
- 513
- Ø Merge
- 2 T. 30 Min.
- Gemergte PRs (30 T.)
- 8
Beschreibung
We should render docs for methods by default rather than requiring showdoc(...) on each method. Of course its better if people use showdoc(method) as that promotes better docs, but perhaps for people starting out it can help with initial setup?
Beitragsleitfaden
Rechercherichtung
Es wird keine Datei, kein Test und kein Einstiegspunkt genannt. Beginne damit, die Implementierung und die Tests für showdoc(method) zu finden, und vergleiche dann die standardmäßige Darstellung mit showdoc(...). Als abgeschlossen gilt die Aufgabe, wenn die Methodendokumentation gerendert wird, ohne showdoc(...) zu benötigen, während die bestehende explizite Verwendung weiterhin unterstützt wird.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- jupyter-notebook, python
- Bereich
- documentation
- Issue-Typ
- Feature
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 30/100