jni / jni/using-python-for-science
Check appropriate format and nesting
- Lenguaje dominante
- TeX
- Estrellas
- 9
- Forks
- 2
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Descripción
The migrate tool for Jupyter Book v0.11 automatically set the ["format: " entry](https://github.com/jni/using-python-for-science/blob/08992d40aabb143c8cd53e7dcad81af06328015c/using-python-for-science/_toc.yml#L3) in our _toc.yml to "jb-article". The [documentation](https://jupyterbook.org/customize/toc.html) suggests the format "jb-book", which I did, and structuring the text into Parts, Chapters, and Sections, which I didn't — our highest level of grouping is chapters. However we do have certain chapter groupings (Get it working, Get it right, Get it fast, Ship it) that could be made into parts, so we could consider grouping other chapters similarly.
Guía de contribución
Línea de trabajo
Comienza con el _toc.yml del repositorio y la documentación enlazada sobre la tabla de contenidos de Jupyter Book. Revisa las agrupaciones de capítulos actuales, incluidas Get it working, Get it right, Get it fast y Ship it, y determina si se deberían actualizar el formato del libro y la anidación; se considera terminado cuando la estructura elegida está representada de forma coherente en _toc.yml.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- jupyter, python
- Área
- documentation
- Tipo de issue
- Documentación
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 35/100