AnswerDotAI / AnswerDotAI/nbdev
Create better documentation of CLI commands
- Vorherrschende Sprache
- Jupyter Notebook
- Sterne
- 5.3k
- Forks
- 514
- Ø Merge
- 2 T. 30 Min.
- Gemergte PRs (30 T.)
- 8
Beschreibung
A single list of all the commands, but with the following improvements
1. A link to the associated function (should also make sure the names match the command)
2. A bit more detail in some cases about what each thing does ex: `nbdev_proc_nbs`
3. How each command relates to eachother
Can we display the markdown representation of all these functions in addition to running `! nbdev_help` ?
Beitragsleitfaden
Rechercherichtung
Beginne mit der vorhandenen Befehlsliste und dem im Issue erwähnten Einstiegspunkt `! nbdev_help`. Dokumentiere Links zu jeder zugehörigen Funktion, überprüfe die Befehlsnamen, füge Details wie `nbdev_proc_nbs` hinzu, erkläre die Beziehungen zwischen den Befehlen und füge die Markdown-Darstellung der Funktionen ein.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- jupyter, python
- Bereich
- cli, documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100