fix: set SHOW_AXES to False by default#443
Open
VPK570 wants to merge 1 commit intobrainglobe:mainfrom
Open
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #443 +/- ##
=======================================
Coverage 86.60% 86.60%
=======================================
Files 27 27
Lines 1239 1239
=======================================
Hits 1073 1073
Misses 166 166 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
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 axes are shown by default but don't need to be.
Users who don't want axes currently have to explicitly
set settings.SHOW_AXES = False in their code.
What does this PR do?
Sets SHOW_AXES to False in brainrender/settings.py so
axes are hidden by default.
References:
Fixes #441
How has this PR been tested?
Changed the setting locally and verified the grep output
confirms SHOW_AXES = False in settings.py. The change is
a single boolean value with no logic implications beyond
what is already tested via the existing render.py usage.
Is this a breaking change?
This could be considered a minor breaking change for users
who rely on axes being shown by default. They will need to
explicitly set settings.SHOW_AXES = True.
Does this PR require an update to the documentation?
The examples/settings.py already demonstrates how to toggle
SHOW_AXES, so no documentation update is needed.
Checklist: