Skip to content

DX-2970 Documenting UnparsedAddress as Read-Only#94

Merged
brianluisgomez merged 3 commits into
masterfrom
DX-2970
Nov 21, 2022
Merged

DX-2970 Documenting UnparsedAddress as Read-Only#94
brianluisgomez merged 3 commits into
masterfrom
DX-2970

Conversation

@brianluisgomez

Copy link
Copy Markdown
Contributor

No description provided.

@brianluisgomez brianluisgomez requested a review from a team November 15, 2022 12:21
Comment thread src/simpleModels/ServiceAddress.php Outdated
"PlusFour" => array("type" => "string"),
"AddressType" => array("type" => "string"),
"UnparsedAddress" => array("type" => "string")
"UnparsedAddress" => array("type" => "string") // Note that UnparsedAddress is Read-Only!

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good coding practice is to not comment your code but if you do put it before the line of code under context

Comment thread src/simpleModels/ServiceAddress.php Outdated
"PlusFour" => array("type" => "string"),
"AddressType" => array("type" => "string"),
"UnparsedAddress" => array("type" => "string") // Note that UnparsedAddress is Read-Only!
// Note that UnparsedAddress is Read-Only.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@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!

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good, I expanded the comment

@brianluisgomez brianluisgomez merged commit d0761fc into master Nov 21, 2022
@brianluisgomez brianluisgomez deleted the DX-2970 branch November 21, 2022 19:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants