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

Đang mở
#944 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức phù hợp với người mới
72/100
Loại issue
Tính năng
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
jupyter, python
Lĩnh vực
documentation, tooling

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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.

Ngôn ngữ chính
C++
Star
3.6k
Fork
652
Merge trung bình
1 ngày 23 giờ
Pull request đã merge (30 ngày)
90

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của petercorke/robotics-toolbox-python

Tất cả issue của petercorke/robotics-toolbox-python

Issue tương tự

Thêm issue về C++

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.