AnswerDotAI / AnswerDotAI/nbdev

`nbdev_clean` documentation partly wrong

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

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!

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Inizia dalla voce collegata della documentazione dell’API per nbdev_clean e confronta la descrizione di fname con il comportamento del comando indicato nell’issue. Aggiorna la documentazione per distinguere un singolo nome o percorso di notebook dagli argomenti non supportati per più file e dai pattern glob, quindi verifica gli esempi documentati.

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

Valutazione

Stack tecnologico
jupyter-notebook, python
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
1/5
Tempo stimato
Meno di un'ora
Stato di attività
Ferma
Chiarezza
Specificata chiaramente
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.