DX-2970 Documenting UnparsedAddress as Read-Only #94
Conversation
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
bpateldx
reviewed
Nov 15, 2022
src/simpleModels/ServiceAddress.php
Outdated
| @@ -22,7 +22,7 @@ class ServiceAddress { | |||
| "AddressLine2" => array("type" => "string"), | |||
| "PlusFour" => array("type" => "string"), | |||
| "AddressType" => array("type" => "string"), | |||
| "UnparsedAddress" => array("type" => "string") | |||
| "UnparsedAddress" => array("type" => "string") // Note that UnparsedAddress is Read-Only! | |||
There was a problem hiding this comment.
Good coding practice is to not comment your code but if you do put it before the line of code under context
bpateldx
suggested changes
Nov 15, 2022
src/simpleModels/ServiceAddress.php
Outdated
| @@ -22,7 +22,8 @@ class ServiceAddress { | |||
| "AddressLine2" => array("type" => "string"), | |||
| "PlusFour" => array("type" => "string"), | |||
| "AddressType" => array("type" => "string"), | |||
| "UnparsedAddress" => array("type" => "string") // Note that UnparsedAddress is Read-Only! | |||
| // Note that UnparsedAddress is Read-Only. | |||
There was a problem hiding this comment.
@brianluisgomez How about expanding the comment to also indicate passing it does not automatically populate individual Address fields? read-only generally means once it's set it cannot be updated!
There was a problem hiding this comment.
Sounds good, I expanded the comment
bpateldx
approved these changes
Nov 16, 2022
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.
No description provided.