`nbdev_clean` documentation partly wrong
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 1/5
- Tiempo estimado
- Menos de una hora
- Aptitud para principiantes
- 35/100
- Tipo de issue
- Documentación
- Claridad
- Bien especificado
- Estado de actividad
- Estancado
- Stack tecnológico
- jupyter-notebook, python
- Área
- documentation
Línea de trabajo
Comienza en la entrada enlazada de la documentación de la API para nbdev_clean y compara la descripción de fname con el comportamiento del comando indicado en el issue. Actualiza la documentación para distinguir un único nombre o ruta de notebook de los argumentos no compatibles para varios archivos y patrones glob, y luego verifica los ejemplos documentados.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
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!
- Lenguaje dominante
- Jupyter Notebook
- Estrellas
- 5.3k
- Forks
- 517
- Merge medio
- 1 min
- PR fusionados (30 d)
- 3
Preparar el entorno
- Sin Dockerfile ni archivo de Docker Compose
- Sin plantilla de pull request
- Leer la guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de AnswerDotAI/nbdev
-
Bug Report: `nbdev` Parser `IndexError` on `@patch_to` with Keyword ArgumentsPosiblemente ocupada @ruchi-mish90 la tomó hace 85 días. Abiertobug
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
AnswerDotAI/nbdev#1596 · 1 comentario ·
-
`great-docs` by Posit Is here!Abierto
Dificultad 5/5 Más de una semana Aptitud para principiantes 25/100
AnswerDotAI/nbdev#1587 ·
-
Interested in Windows support?Posiblemente ocupada @mrexodia la tomó hace 10 días. Abierto
Dificultad 4/5 3-5 días Aptitud para principiantes 35/100
AnswerDotAI/nbdev#1584 · 1 comentario ·
-
Dificultad 3/5 1-2 días Aptitud para principiantes 35/100
AnswerDotAI/nbdev#1583 · 1 comentario · 1 reacción ·
-
bug
Dificultad 3/5 1-2 días Aptitud para principiantes 52/100
AnswerDotAI/nbdev#1581 ·
Todos los issues de AnswerDotAI/nbdev
Issues similares
-
documentation
Dificultad 2/5 1-3 horas Aptitud para principiantes 70/100
Los mantenedores suelen responder en 1 día
-
documentation good first issue
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
-
good first issue
Dificultad 2/5 1-3 horas Aptitud para principiantes 70/100
-
[Doc] - Creation du READMEAbierto
Dificultad 1/5 1-3 horas Aptitud para principiantes 62/100
Hira-shi/PW1-DAI-Carrel-Egal-Eyer#28 ·
Los mantenedores suelen responder en 1 día
-
How do I build the project?Abierto
Dificultad 1/5 1-3 horas Aptitud para principiantes 70/100
Los mantenedores suelen responder en 1 día