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

Ouverte
#944 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 1 jour

Personne n'a encore pris cette issue.

Évaluation

Difficulté
3/5
Temps estimé
1-2 jours
Accessibilité débutants
72/100
Type d'issue
Fonctionnalité
Clarté
Clairement spécifiée
Activité
Active
Stack technique
jupyter, python

Piste de recherche

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.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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.

Langage dominant
C++
Étoiles
3.6k
Forks
652
Merge moyen
1 j 23 h
PR mergées (30 j)
90

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de petercorke/robotics-toolbox-python

Toutes les issues de petercorke/robotics-toolbox-python

Issues similaires

Plus d'issues C++

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.