Repository navigation
Conversation
The notebook docs said the %burr_ui magic prints the URL of the UI. Since the iframe support was added it embeds the UI below the cell instead, and only prints the URL with --no-iframe. - docs/ui/notebook.rst: describe the iframe default, the background server on port 7241 that later calls reuse, and the --height/-h and --no-iframe options. - docs/concepts/tracking.rst: correct the intro and the example, and link to the notebook page.
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Corrects the notebook docs for the
%burr_uimagic. It says it prints the URL of the UI, but since the iframe support (d0db4e8, Nov 2024) it embeds the UI below the cell and only prints the URL with--no-iframe. Related to #272 (it does not close it).Changes
docs/ui/notebook.rst: describe the iframe default, the background server on port 7241 that later calls reuse, and the--height/-hand--no-iframeoptions.docs/concepts/tracking.rst: correct the intro and the example, and link to the notebook page.How I tested this
Checked with Claude Code, which ran these on Windows 11 / Python 3.13:
%burr_uiin a real Jupyter kernel against the releasedapache-burr0.43.0. It showed an iframe with height 400.--height 600and-h 555changed the height.--no-iframeprintedBurr UI: http://127.0.0.1:7241. Repeated calls reused the same server process.python -m sphinx -T -W --keep-going -b dirhtml ...). It passes before and after, and I read the rendered HTML of both sections.pre-commit run --all-filesgives the same result before and after. The changed files pass. Black fails on two example files I did not touch, and it fails the same way onmain.Notes
burr/integrations/notebook.py, not from running it.python. On my Windows setup that picked an interpreter without burr, so the iframe stayed blank. That is tracked in Notebook UI launcher should use the current Python interpreter #981 / fix(notebook): launch UI with current Python interpreter #982 and is not fixed here.Checklist