InsightSoftwareConsortium / InsightSoftwareConsortium/SimpleITK-Notebooks
Writing a notebook contribution guide
- Lingua principale
- Jupyter Notebook
- Stelle
- 906
- Fork
- 374
- Merge medio
- 54m
- PR unite (30g)
- 1
Descrizione
As discussed in #321, it is desired to keep the jupyter notebooks clean for version control.
Therefore, a contribution Guide for the notebooks could be written.
This guide could also be in form of a notebook and live at https://simpleitk-notebooks.readthedocs.io/.
Things that come into my mind for notebooks right now:
* They should get formatted by the `black` formatter.
* Metadata and empty cells should be cleaned by `nbstripout Python/*.ipynb --strip-empty-cells`
Guida per i contributori
Apri la guida per i contributori
Direzione di ricerca
Start by reviewing issue #321 and the notebook contribution needs described there, then inspect the notebooks under Python/*.ipynb. The guide should be added to the SimpleITK Notebooks documentation at readthedocs.io and explain Black formatting plus the nbstripout command with empty-cell stripping; it is done when these cleanup steps are documented for contributors.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- jupyter-notebook, python
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 35/100