Update AutoClone.md #328
Merged
Update AutoClone.md #328
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
Rephrase the comments to make them clearer as to what's going on.
Slightly changed the phrasing
jodydonetti
approved these changes
Nov 27, 2024
oasaleh
commented
Nov 29, 2024
| var person1 = cache.GetOrDefault<Person>("foo", options => options.SetAutoClone(true)); | ||
| Console.WriteLine($"person1: {person1.Name}"); | ||
| Console.WriteLine(); | ||
|
|
||
| // RETURNS A CLONE OF CACHED INSTANCE (MODIFICATIONS AFFECT ONLY THE CLONE) | ||
| // RETURNS A CLONE OF THE CACHED INSTANCE: CHANGES APPLIED ONLY THE CLONE, CACHED INSTANCE REMAINS UNCHANGED |
There was a problem hiding this comment.
I noticed a couple of points regarding this comment:
- The phrase “applied only” should be updated to “applied only to” for grammatical correctness.
- The comment feels slightly verbose, which makes it less clear. For example, the term “clone” is used without pairing it with “instance”. Using “cloned instance” would improve clarity and consistency. I think reverting it back to
(MODIFICATIONS AFFECT ONLY THE CLONE)would be ideal. However, this version could also work:
// RETURNS A CLONED INSTANCE OF THE CACHED OBJECT: CHANGES ARE APPLIED ONLY TO THE CLONED INSTANCE, LEAVING THE CACHED INSTANCE UNMODIFIED
oasaleh
commented
Nov 29, 2024
| var person2 = cache.GetOrDefault<Person>("foo", options => options.SetAutoClone(true)); | ||
| person2.Name = "Jane"; | ||
| Console.WriteLine($"person1: {person1.Name}"); | ||
| Console.WriteLine($"person2: {person2.Name}"); | ||
| Console.WriteLine(); | ||
|
|
||
| // RETURNS DIRECT REFERENCE TO CACHED INSTANCE (MODIFICATIONS AFFECT THE CACHE) | ||
| // RETURNS DIRECT REFERENCE TO THE CACHED INSTANCE: CHANGES APPLIED TO THE CACHED INSTANCE ITSELF |
There was a problem hiding this comment.
Same as the comment above. Also, it's missing the verb "are" in "Changes are applied to", which makes it verbose. 🤷
jodydonetti
approved these changes
Dec 13, 2024
There was a problem hiding this comment.
LGTM
(sorry for the delay, got carried away by the latest preview for the big v2 getting out soon)
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.
This pull request includes updates to the documentation to clarify the behavior of the
GetOrDefaultmethod when using theSetAutoCloneoption in theFusionCachelibrary.Documentation improvements:
docs/AutoClone.md: Updated comments to clarify that usingSetAutoClone(true)returns a clone of the cached instance, and modifications affect only the clone, while not usingSetAutoClonereturns a direct reference to the cached instance, and modifications affect the cache.