Skip to content

fix: replace removed embedWindow with correct vedo backend instructions#437

Merged
IgorTatarnikov merged 5 commits intobrainglobe:mainfrom
AdityaGupta716:fix/update-jupyter-error-message
Mar 13, 2026
Merged

fix: replace removed embedWindow with correct vedo backend instructions#437
IgorTatarnikov merged 5 commits intobrainglobe:mainfrom
AdityaGupta716:fix/update-jupyter-error-message

Conversation

@AdityaGupta716
Copy link
Contributor

What does this PR do?

Fixes the misleading error message in brainrender/_jupyter.py that
referenced vedo.embedWindow, which has been removed from the vedo library.

Why is this needed?

Closes #413

Changes

  • Removed all references to the non-existent embedWindow API
  • Updated the error message in the not_on_jupyter decorator to direct
    users to set vedo.settings.default_backend = 'k3d' for notebook use
  • Added a note that some features are unavailable in k3d, and recommends
    running in a standard Python script or terminal for full functionality

How was this tested?

  • Verified valid vedo backend values directly from vedo 2026.6.1 source code
  • "k3d" confirmed as the correct notebook backend in vedo settings

Is this a breaking change?

No

Does this require a documentation update?

No

@AdityaGupta716
Copy link
Contributor Author

Hey @alessandrofelder @adamltyson, please review when you get a chance! Removes all references to the defunct vedo.embedWindow and replaces the error message with accurate guidance, verified directly against vedo 2026.6.1 source.

@codecov
Copy link

codecov bot commented Feb 27, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 86.60%. Comparing base (42c6ef1) to head (c5640ff).
⚠️ Report is 4 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #437   +/-   ##
=======================================
  Coverage   86.60%   86.60%           
=======================================
  Files          27       27           
  Lines        1239     1239           
=======================================
  Hits         1073     1073           
  Misses        166      166           

☔ 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
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.

Hi @AdityaGupta716, this looks great! Just a small comment regarding formatting.

Co-authored-by: Igor Tatarnikov <61896994+IgorTatarnikov@users.noreply.github.com>
@AdityaGupta716
Copy link
Contributor Author

@IgorTatarnikov commited the change thanks

Copy link
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.

LGMT 🎉 thanks @AdityaGupta716

@IgorTatarnikov IgorTatarnikov merged commit 62a434f into brainglobe:main Mar 13, 2026
12 checks passed
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] embedWindow removed from vedo so brainrender error message is misleading.

2 participants