Clarify the JSON data referenced in patterns sample is deserialized #6422

MiniPiku · 2025-02-15T20:13:55Z

Renamed the variable json to data throughout the section.
Updated the text to clarify that the example works with deserialized data (e.g., parsed from JSON) rather than raw JSON strings.
Ensured consistency in variable naming and explanations.

This update makes the documentation more accurate and avoids misleading readers into thinking that the variable holds a JSON string.

1. Renamed the variable json to data throughout the section. 2. Updated the text to clarify that the example works with deserialized data (e.g., parsed from JSON) rather than raw JSON strings. 3. Ensured consistency in variable naming and explanations. This update makes the documentation more accurate and avoids misleading readers into thinking that the variable holds a JSON string. If you’re contributing to the Dart documentation, you can submit this change as a pull request to the [site-www repository](https://github.com/dart-lang/site-www)

google-cla · 2025-02-15T20:14:00Z

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

MiniPiku · 2025-02-15T20:47:59Z

Hi @maintainers, could you please approve the workflows for this PR? Thank you!

MiniPiku · 2025-02-15T21:10:22Z

@dcharkes can you please review this PR?
Thank you :)

ilyash-b · 2025-02-17T05:06:42Z

src/content/language/patterns.md

+if (data is Map<String, Object?> &&
+data.length == 1 &&
+data.containsKey('user')) {
+var user = data['user'];
+if (user is List<Object> &&
+user.length == 2 &&
+user[0] is String &&
+user[1] is int) {
+var name = user[0] as String;
+var age = user[1] as int;
+print('User $name is $age years old.');
+}


Looks like spacing was erroneously removed (here and in the next hunk).

Can you kindly check it again
i fixed the spacing issue
thank you

ilyash-b · 2025-02-17T05:07:13Z

src/content/language/patterns.md~

Looks like this file was not intended to be part of the commit.

MiniPiku · 2025-02-17T08:36:33Z

Kindly check Fixed the spacing issue : 7a12801

________________________________ From: Ilya Sher ***@***.***> Sent: 17 February 2025 10:37 To: dart-lang/site-www ***@***.***> Cc: MiniPiku ***@***.***>; Author ***@***.***> Subject: Re: [dart-lang/site-www] Summary of Changes : (PR #6422) @ilyash-b commented on this pull request.

________________________________ In src/content/language/patterns.md<#6422 (comment)>:

+if (data is Map<String, Object?> &&

+data.length == 1 && +data.containsKey('user')) { +var user = data['user']; +if (user is List<Object> && +user.length == 2 && +user[0] is String && +user[1] is int) { +var name = user[0] as String; +var age = user[1] as int; +print('User $name is $age years old.'); +} Looks like spacing was erroneously removed (here and in the next hunk). — Reply to this email directly, view it on GitHub<#6422 (review)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/A754NWW42VQOXGKILZWAUC32QFU7RAVCNFSM6AAAAABXGZINAWVHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMZDMMRQGAZTKNZTHA>. You are receiving this because you authored the thread.Message ID: ***@***.***>

MiniPiku · 2025-02-17T14:40:03Z

Fixed the spacing issue 7a12801

________________________________ From: Ilya Sher ***@***.***> Sent: 17 February 2025 10:37 To: dart-lang/site-www ***@***.***> Cc: MiniPiku ***@***.***>; Author ***@***.***> Subject: Re: [dart-lang/site-www] Summary of Changes : (PR #6422) @ilyash-b commented on this pull request.

________________________________ In src/content/language/patterns.md<#6422 (comment)>:

+if (data is Map<String, Object?> &&

+data.length == 1 && +data.containsKey('user')) { +var user = data['user']; +if (user is List<Object> && +user.length == 2 && +user[0] is String && +user[1] is int) { +var name = user[0] as String; +var age = user[1] as int; +print('User $name is $age years old.'); +} Looks like spacing was erroneously removed (here and in the next hunk). — Reply to this email directly, view it on GitHub<#6422 (review)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/A754NWW42VQOXGKILZWAUC32QFU7RAVCNFSM6AAAAABXGZINAWVHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMZDMMRQGAZTKNZTHA>. You are receiving this because you authored the thread.

MiniPiku · 2025-02-19T03:50:54Z

@ilyash-b
Can you kindly review the PR again
All the spacing issues are fixed
Thank you

MiniPiku · 2025-02-20T19:00:37Z

@ilyash-b
just a reminder that the issue have been resolved
can you kindly review the PR

parlough

Thanks for thinking to clarify this @MiniPiku, it makes a lot of sense to do so.

In general these changes look good to me, but there is a failing test due to needing to update the source file as well. The snippets will need proper formatting as well.

Thanks again for the PR and let me know if you have any issues or questions. If you'd prefer, I'd be happy to make the necessary updates as well, just let me know :)

Also as a note, you don't need to ping/tag anyone to review your PRs. Generally different repositories have triage processes that will make sure your work gets reviewed. For us, it could take a few days or up to a week. We appreciate your patience :)

parlough · 2025-02-21T02:08:45Z

src/content/language/patterns.md

@@ -360,14 +360,14 @@ double calculateArea(Shape shape) => switch (shape) {
 ### Validating incoming JSON

 [Map][] and [list][] patterns work well for destructuring key-value pairs in
-JSON data:
+deserialized data, such as data parsed from JSON:


Nice clarification!

parlough · 2025-02-21T02:10:03Z

src/content/language/patterns.md

@@ -360,14 +360,14 @@ double calculateArea(Shape shape) => switch (shape) {
 ### Validating incoming JSON

 [Map][] and [list][] patterns work well for destructuring key-value pairs in
-JSON data:
+deserialized data, such as data parsed from JSON:

 <?code-excerpt "language/lib/patterns/json.dart (json-1)"?>


Each of these code snippets are extracted from https://github.com/dart-lang/site-www/blob/main/examples/language/lib/patterns/json.dart (as specified by the <?code-excerpt instructions).

Can you also update the source in that file to account for these changes?

If you followed the repository setup instructions, you can then use dart run dart_site refresh-excerpts to update these snippets in the Markdown to match the source files. Or you can manually update them to match.

parlough · 2025-02-21T02:13:59Z

src/content/language/patterns.md

+var name = user[0] as String;
+var age  = user[1] as int;
+print('User $name is $age years old.');


Looks like some indentation was lost here:

Suggested change

var name = user[0] as String;

var age = user[1] as int;

print('User $name is $age years old.');

var name = user[0] as String;

var age = user[1] as int;

print('User $name is $age years old.');

parlough · 2025-02-21T02:15:08Z

src/content/language/patterns.md~

It looks like this file was included on accident as a duplicate of the original. Did you intend to commit it?

MiniPiku · 2025-02-21T05:44:37Z

@parlough i updated the desired files and remove the false commit
can you take a look and review if there is something more to do
3a45342

thank you

MiniPiku mentioned this pull request Feb 15, 2025

Incorrect variable name - json #6411

Open

1 task

ilyash-b reviewed Feb 17, 2025

View reviewed changes

src/content/language/patterns.md~ Outdated

Copy link

ilyash-b Feb 17, 2025

Choose a reason for hiding this comment

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

Looks like this file was not intended to be part of the commit.

fixed(Indentation): Restored proper spacing in code block

7a12801

MiniPiku force-pushed the json branch from 9ae81f4 to 7a12801 Compare February 17, 2025 08:31

parlough changed the title ~~Summary of Changes :~~ Clarify the JSON data referenced in patterns sample is deserialized Feb 21, 2025

parlough reviewed Feb 21, 2025

View reviewed changes

Changes:

3a45342

MiniPiku force-pushed the json branch from 7b213a8 to 3a45342 Compare February 21, 2025 05:41

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Clarify the JSON data referenced in patterns sample is deserialized #6422

Clarify the JSON data referenced in patterns sample is deserialized #6422

MiniPiku commented Feb 15, 2025

google-cla bot commented Feb 15, 2025

MiniPiku commented Feb 15, 2025

MiniPiku commented Feb 15, 2025

ilyash-b Feb 17, 2025

MiniPiku Feb 17, 2025

ilyash-b Feb 17, 2025

MiniPiku commented Feb 17, 2025 via email

MiniPiku commented Feb 17, 2025 via email

MiniPiku commented Feb 19, 2025

MiniPiku commented Feb 20, 2025

parlough left a comment •

edited

Loading

parlough Feb 21, 2025

parlough Feb 21, 2025

parlough Feb 21, 2025

parlough Feb 21, 2025

MiniPiku commented Feb 21, 2025

Clarify the JSON data referenced in patterns sample is deserialized #6422

Are you sure you want to change the base?

Clarify the JSON data referenced in patterns sample is deserialized #6422

Conversation

MiniPiku commented Feb 15, 2025

google-cla bot commented Feb 15, 2025

MiniPiku commented Feb 15, 2025

MiniPiku commented Feb 15, 2025

ilyash-b Feb 17, 2025

Choose a reason for hiding this comment

MiniPiku Feb 17, 2025

Choose a reason for hiding this comment

ilyash-b Feb 17, 2025

Choose a reason for hiding this comment

MiniPiku commented Feb 17, 2025 via email

MiniPiku commented Feb 17, 2025 via email

MiniPiku commented Feb 19, 2025

MiniPiku commented Feb 20, 2025

parlough left a comment • edited Loading

Choose a reason for hiding this comment

parlough Feb 21, 2025

Choose a reason for hiding this comment

parlough Feb 21, 2025

Choose a reason for hiding this comment

parlough Feb 21, 2025

Choose a reason for hiding this comment

parlough Feb 21, 2025

Choose a reason for hiding this comment

MiniPiku commented Feb 21, 2025

parlough left a comment •

edited

Loading