Notebook bootstrap cell: tell the reader to wait while it installs (follow bdsim#270)

Aperta
#944 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
72/100
Tipo di issue
Funzionalità
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
jupyter, python

Direzione di ricerca

Read _rtb_nb_bootstrap.py and this repository’s sync_bootstrap.py, then compare the template changes described in the issue with bdsim#270. Regenerate the bootstrap cell in every notebook and review the diffs for the added folded-cell header and install message. Done means the JupyterLite notebook shows Installing ... before Running ...; the issue also asks for a check after the docs deploy.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

The bootstrap cell at the top of each notebook can take some seconds to run, most of all in JupyterLite, and a reader who has not seen it before cannot tell a wait from a hang. bdsim has fixed this (petercorke/bdsim#270) from a change to the shared template (petercorke/rvc-ecosystem#35). RTB should pick it up so the three toolboxes stay in step. This is separate from the JupyterLite convergence in #941.

What changed in the template (notebooks/bootstrap_template.py and notebooks/sync_bootstrap.py in rvc-ecosystem):

  • The first line of the generated cell, which is what shows when the cell is folded, now reads # RTB_BOOTSTRAP_CELL: installs the package, which takes a short time, so wait for the line "Running ..." below. Generated by sync_bootstrap.py from _rtb_nb_bootstrap.py, do not edit. The marker prefix is unchanged.
  • The install is announced as it starts: print(f"Installing {PACKAGE}, this takes a short time...", flush=True). JupyterLite printed nothing before; Colab printed a shorter message. A local run only imports, so it prints nothing extra.

To do here

  1. Copy the same two changes into _rtb_nb_bootstrap.py: the print after the piplite/micropip import in the emscripten branch, and the reworded Colab print.
  2. Change the header text in this repo's copy of sync_bootstrap.py to match, then regenerate the cell in every notebook. See bdsim#270 for what the diff looks like: one new first line plus one print per notebook.
  3. Open one notebook in the JupyterLite site after the docs deploy and check that Installing ... appears before Running ....

Details: rvc-ecosystem notebooks.md section 3, and the rvc-ecosystem PR above.

Lingua principale
C++
Stelle
3.6k
Fork
652
Merge medio
1g 23h
PR unite (30g)
90

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di petercorke/robotics-toolbox-python

Tutte le issue di petercorke/robotics-toolbox-python

Issue simili

Altre issue su C++

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.