Do not mutate scalar_ bar_args
#1357
Merged
Conversation
This file contains 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
Codecov Report
@@ Coverage Diff @@
## master #1357 +/- ##
=======================================
Coverage 90.06% 90.07%
=======================================
Files 58 58
Lines 12265 12267 +2
=======================================
+ Hits 11047 11049 +2
Misses 1218 1218 |
adeak
reviewed
Jun 5, 2021
adeak
approved these changes
Jun 5, 2021
| if "scalar" in kwargs: | ||
| raise TypeError("`scalar` is an invalid keyword argument for `add_mesh`. Perhaps you mean `scalars` with an s?") | ||
| assert_empty_kwargs(**kwargs) | ||
|
|
||
| # Avoid mutating input | ||
| if scalar_bar_args is None: | ||
| scalar_bar_args = {} |
There was a problem hiding this comment.
I know this is unrelated to the PR, but I'm wondering if it makes sense that n_colors is not set for add_volume. It might not hurt to check that n_colors affects the colorbar for add_mesh .
There was a problem hiding this comment.
It would also be nice to extract out the common functionality for these things into a helper to make it consistent. I think this should be a different PR as it is about functionality (with a possibly breaking change) rather than fixing an unintended effect.
|
I'm merging this for the 0.31.0 release. For the record, two potential unresolved issues for future PRs. |
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.
Overview
This PR copies
scalar_bar_argsto avoid mutating the passed in variable inadd_meshandadd_volume.Fixes #1353
Details
Tests added for future regression testing.