Block Editor: Rename immutableSet to setImmutably #50040
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
|
Size Change: +2.85 kB (0%) Total Size: 1.37 MB
ℹ️ View Unchanged
|
tyxla
approved these changes
Apr 25, 2023
| * | ||
| * @param {Object} object Object to set a value in. | ||
| * @param {number|string|Array} path Path in the object to modify. | ||
| * @param {*} value New value to set. | ||
| * @return {Object} Cloned object with the new value set. | ||
| */ | ||
| export function immutableSet( object, path, value ) { | ||
| export function setImmutably( object, path, value ) { |
There was a problem hiding this comment.
I think this rename could use a CHANGELOG entry. We already have an existing changelog entry for immutableSet so by keeping a changelog entry for renaming it, one could trace what happened to it.
| * | ||
| * @param {Object} object Object to set a value in. | ||
| * @param {number|string|Array} path Path in the object to modify. | ||
| * @param {*} value New value to set. | ||
| * @return {Object} Cloned object with the new value set. | ||
| */ | ||
| export function immutableSet( object, path, value ) { | ||
| export function setImmutably( object, path, value ) { |
There was a problem hiding this comment.
I just wanted to note that from my perspective, immutableSet wasn't a bad name, recognizable since it exists in other languages (Java AFAIK) and also there's Immutable.js and an immutable-set package. I've never seen setImmutably in code, rather I've seen setImmutable. I don't have very strong feelings about it though.
There was a problem hiding this comment.
If I'm the only one having problems with the name, then I'm happy to close this PR! I opened it based on the two 👍 reactions to the original comment. Or, at the very least, revert the name change and just rephrase the docblock. wdyt, @tyxla?
There was a problem hiding this comment.
To be honest, I did have a small issue with the name, at first I also didn't know what the function did until I looked at the tests. It felt more as an object creator. But I generally don't feel strongly about the naming things.
There was a problem hiding this comment.
I agree naming is hard. I also agree with y'all that immutableSet is far from ideal. I'm just not convinced that setImmutably is much better. At the same time, I can't think of a better name that isn't longer. Just like Riad, I have no strong feelings either. That's precisely why I approved the PR and am happy to go with what you suggested 😉
There was a problem hiding this comment.
Alright, kids! Then I guess I'll merge once it's green. :)
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.
Also tweaked the documentation of the function.
Addresses #49365 (comment)