Fix/harmonize notebook render suggestion#444
Open
VPK570 wants to merge 2 commits intobrainglobe:mainfrom
Open
Conversation
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.
What is this PR:
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: