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

オープン
#944 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
3/5
見積もり時間
1〜2日
初心者へのやさしさ
72/100
issue の種類
機能追加
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
jupyter, python

調査の方向性

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.

索引モデルが issue の本文から書いたものです。

説明

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.

主要言語
C++
スター
3.6k
フォーク
652
平均マージ
1日 23時間
マージ済み PR(30日)
90

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

petercorke/robotics-toolbox-python のほかの issue

petercorke/robotics-toolbox-python の issue をすべて見る

似ている issue

C++ の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。