`nbdev_clean` documentation partly wrong
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 1/5
- Temps estimé
- Moins d'une heure
- Accessibilité débutants
- 35/100
- Type d'issue
- Documentation
- Clarté
- Clairement spécifiée
- Activité
- À l'abandon
- Stack technique
- jupyter-notebook, python
- Domaine
- documentation
Piste de recherche
Commencez par l’entrée liée de la documentation de l’API pour nbdev_clean et comparez la description de fname avec le comportement de la commande indiqué dans l’issue. Mettez à jour la documentation afin de distinguer un seul nom ou chemin de notebook des arguments non pris en charge pour plusieurs fichiers et des motifs glob, puis vérifiez les exemples documentés.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
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!
- Langage dominant
- Jupyter Notebook
- Étoiles
- 5.3k
- Forks
- 516
- Merge moyen
- 2 j 7 h
- PR mergées (30 j)
- 1
Préparer son environnement
- Aucun Dockerfile ni fichier Docker Compose
- Aucun modèle de pull request
- Lire le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de AnswerDotAI/nbdev
-
Bug Report: `nbdev` Parser `IndexError` on `@patch_to` with Keyword ArgumentsPeut-être pris @ruchi-mish90 l’a pris il y a 102 jours. Ouvertebug
Difficulté 2/5 1-3 heures Accessibilité débutants 78/100
AnswerDotAI/nbdev#1596 · 1 commentaire ·
-
`great-docs` by Posit Is here!Ouverte
Difficulté 5/5 Plus d'une semaine Accessibilité débutants 25/100
AnswerDotAI/nbdev#1587 ·
-
Interested in Windows support?Peut-être pris @mrexodia l’a pris il y a 27 jours. Ouverte
Difficulté 4/5 3-5 jours Accessibilité débutants 35/100
AnswerDotAI/nbdev#1584 · 1 commentaire ·
-
Difficulté 3/5 1-2 jours Accessibilité débutants 35/100
AnswerDotAI/nbdev#1583 · 1 commentaire · 1 réaction ·
-
bug
Difficulté 3/5 1-2 jours Accessibilité débutants 52/100
AnswerDotAI/nbdev#1581 ·
Toutes les issues de AnswerDotAI/nbdev
Issues similaires
-
chore(worker): five module header comments describe the code from before later issues changed itOuvertearea:dev U2-later
Difficulté 2/5 1-3 heures Accessibilité débutants 78/100
bentleypark/aiwatch#1824 ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 72/100
Les mainteneurs répondent en général sous 1 jour
-
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
Difficulté 1/5 Moins d'une heure Accessibilité débutants 76/100
Berserk-hub150/skillhawk#244 · 1 commentaire ·
Les mainteneurs répondent en général sous 8 jours
-
documentation
Difficulté 2/5 1-3 heures Accessibilité débutants 68/100
Judgment-Pack/judgment-pack-spec#275 ·
Les mainteneurs répondent en général sous 1 jour
-
[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)Peut-être pris @hakuturu583 l’a pris aujourd’hui. Ouvertebug documentation
Difficulté 2/5 1-3 heures Accessibilité débutants 88/100
autowarefoundation/autoware_carla_scenario#665 ·
Les mainteneurs répondent en général sous 1 jour