jni / jni/using-python-for-science
Check appropriate format and nesting
- Vorherrschende Sprache
- TeX
- Sterne
- 9
- Forks
- 2
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
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.
Beitragsleitfaden
Rechercherichtung
Start with the repository's _toc.yml and the linked Jupyter Book table-of-contents documentation. Review the current chapter groupings, including Get it working, Get it right, Get it fast, and Ship it, and determine whether the book format and nesting should be updated; done means the chosen structure is consistently represented in _toc.yml.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- jupyter, python
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100