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

Abierto
#944 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
72/100
Tipo de issue
Nueva funcionalidad
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
jupyter, python

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.

Lenguaje dominante
C++
Estrellas
3.6k
Forks
652
Merge medio
1 d 23 h
PR fusionados (30 d)
90

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de petercorke/robotics-toolbox-python

Todos los issues de petercorke/robotics-toolbox-python

Issues similares

Más issues de C++

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.