docs: clarify Immutable Object pattern in Value Object README (fixes #3448)#3449
Open
Senrian wants to merge 1 commit intoiluwatar:masterfrom
Open
docs: clarify Immutable Object pattern in Value Object README (fixes #3448)#3449Senrian wants to merge 1 commit intoiluwatar:masterfrom
Senrian wants to merge 1 commit intoiluwatar:masterfrom
Conversation
PR SummaryResolved issue #3448 by clarifying the Immutable Object pattern in the Value Object README: promoted 'Immutable Object' in the 'Also known as' section, and updated the Intent section header to 'Intent of Value Object / Immutable Object Design Pattern' with explicit benefits of the Immutable Object pattern. Changes
autogenerated by presubmit.ai |
There was a problem hiding this comment.
✅ LGTM!
Review Summary
Commits Considered (1)
Files Processed (1)
- value-object/README.md (2 hunks)
Actionable Comments (0)
Skipped Comments (3)
-
value-object/README.md [22-22]
readability: "Clarify alias terminology"
-
value-object/README.md [26-26]
readability: "Clarify cross-reference with implementation"
-
value-object/README.md [28-30]
readability: "Improve Intent content clarity and Java/Lombok tie-in"
|
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
1 participant
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.
Fixes Issue #3448: Missing Pattern Immutable
The issue requests adding the Immutable Object pattern to the repository. This PR addresses it by:
Note: The Value Object pattern already implements the Immutable Object pattern (using Lombok
@Valueannotation). This PR makes that relationship explicit in the documentation.