Skip to content

Fix/harmonize notebook render suggestion#444

Open
VPK570 wants to merge 2 commits intobrainglobe:mainfrom
VPK570:fix/harmonize-notebook-render-suggestion
Open

Fix/harmonize notebook render suggestion#444
VPK570 wants to merge 2 commits intobrainglobe:mainfrom
VPK570:fix/harmonize-notebook-render-suggestion

Conversation

@VPK570
Copy link

@VPK570 VPK570 commented Mar 17, 2026

What is this PR:

  • ✅ Bug fix

Why is this PR needed?
The suggestion printed by render.py when using the k3d backend
was inconsistent with the example in notebook_workflow.ipynb.
Users following the notebook would see conflicting instructions.

What does this PR do?
Updates the printed suggestion in render.py to use the Plotter()
approach, matching the notebook_workflow.ipynb example as confirmed
by @IgorTatarnikov in #442.

References:
Fixes #442

How has this PR been tested?
Verified the updated text in render.py matches the Plotter()
approach used in examples/notebook_workflow.ipynb. This is a
text-only change to the printed suggestion with no logic changes.

Is this a breaking change?
No. Only changes the text printed to the user, no functional changes.

Does this PR require an update to the documentation?
No. This aligns existing documentation/examples, no new docs needed.

Checklist:

  • ✅ The code has been tested locally
  • ✅ The code has been formatted with pre-commit

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[BUG] The suggestion in examples/notebook_workflow.ipynb don't match the suggestions printed by render.py

1 participant