`nbdev_clean` documentation partly wrong
Dieses Issue hat noch niemand übernommen.
Bewertung
- Schwierigkeit
- 1/5
- Geschätzter Aufwand
- Unter einer Stunde
- Anfängerfreundlichkeit
- 35/100
- Issue-Typ
- Dokumentation
- Klarheit
- Klar beschrieben
- Aktivitätsstatus
- Veraltet
- Tech-Stack
- jupyter-notebook, python
- Bereich
- documentation
Rechercherichtung
Beginne beim verlinkten API-Dokumentationseintrag für nbdev_clean und vergleiche die Beschreibung von fname mit dem im Issue aufgeführten Befehlsverhalten. Aktualisiere die Dokumentation, um einen einzelnen Notebook-Namen oder -Pfad von nicht unterstützten Argumenten für mehrere Dateien und Glob-Mustern zu unterscheiden, und überprüfe anschließend die dokumentierten Beispiele.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Beschreibung
I was trying out nbdev_clean and I realized the documentation is not completely right, which caused me some confusion.
In the documentation (https://nbdev.fast.ai/api/clean.html#nbdev_clean) it says:
fname str None A notebook name or glob to clean
but this is not true, it accepts a single notebook name or a path, but not a glob (see detailed below). Maybe this should be changed to avoid confusion, cause it took me a while to understand what works and what doesn't, and I only figured with the help of old issues.
what works:
- one single file (e.g.
nbdev_clean --fname nb1.ipynb) - a path (e.g.
nbdev_clean --fname ./)
what does not work:
- passing several files (e.g.
nbdev_clean --fname nb1.ipynb nb2.ipynb) - a glob (e.g.
nbdev_clean --fname *.ipynb) - a path with a glob (e.g.
nbdev_clean --fname ./*.ipynb)
Very cool library and features otherwise!
- Vorherrschende Sprache
- Jupyter Notebook
- Sterne
- 5.3k
- Forks
- 516
- Ø Merge
- 2 T. 7 Std.
- Gemergte PRs (30 T.)
- 1
Entwicklungsumgebung
- Kein Dockerfile und keine Docker-Compose-Datei
- Keine Pull-Request-Vorlage
- Beitragsleitfaden lesen
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus AnswerDotAI/nbdev
-
Bug Report: `nbdev` Parser `IndexError` on `@patch_to` with Keyword ArgumentsEvtl. vergeben @ruchi-mish90 hat das vor 102 Tagen übernommen. Offenbug
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 78/100
AnswerDotAI/nbdev#1596 · 1 Kommentar ·
-
Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 25/100
AnswerDotAI/nbdev#1587 ·
-
Interested in Windows support?Evtl. vergeben @mrexodia hat das vor 27 Tagen übernommen. Offen
Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 35/100
AnswerDotAI/nbdev#1584 · 1 Kommentar ·
-
Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 35/100
AnswerDotAI/nbdev#1583 · 1 Kommentar · 1 Reaktion ·
-
bug
Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 52/100
AnswerDotAI/nbdev#1581 ·
Alle Issues in AnswerDotAI/nbdev
Ähnliche Issues
-
chore(worker): five module header comments describe the code from before later issues changed itOffenarea:dev U2-later
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 78/100
bentleypark/aiwatch#1824 ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 72/100
Maintainer antworten meist innerhalb von 1 Tag
-
beginner-friendly category:sarif community enhancement first-timers-only good first issue hacktoberfest help wanted low hanging fruit micro-contribution type: task up-for-grabs
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 76/100
Berserk-hub150/skillhawk#244 · 1 Kommentar ·
Maintainer antworten meist innerhalb von 8 Tagen
-
documentation
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 68/100
Judgment-Pack/judgment-pack-spec#275 ·
Maintainer antworten meist innerhalb von 1 Tag
-
[BUG] docs: tutorial says a scenario passes "when all pass conditions are met"; the runner passes on the first one (and usage.md shows a result message the runner never writes)Evtl. vergeben @hakuturu583 hat das heute übernommen. Offenbug documentation
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 88/100
autowarefoundation/autoware_carla_scenario#665 ·
Maintainer antworten meist innerhalb von 1 Tag