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
Copy Markdown

@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

@codecov
Copy link
Copy Markdown

codecov bot commented Mar 27, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 87.81%. Comparing base (62a434f) to head (8026c63).
⚠️ Report is 3 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #444      +/-   ##
==========================================
+ Coverage   86.60%   87.81%   +1.21%     
==========================================
  Files          27       27              
  Lines        1239     1239              
==========================================
+ Hits         1073     1088      +15     
+ Misses        166      151      -15     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Copy Markdown
Member

@IgorTatarnikov IgorTatarnikov left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @VPK570, just a small comment regarding a change that's not part of this PR.

Once that's reverted it'll be good to merge!

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The change in this file should be reverted as it's technically not part of this PR

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

2 participants