-
Notifications
You must be signed in to change notification settings - Fork 27.3k
Update step_05.ngdoc with JSONLint validation hint #9074
Conversation
Added suggestion to use JSONLint to validate the JSON file and identify errors. It is simpler to address JSON errors independently of other errors at compile-time.
I'm sorry, but I wasn't able to verify your Contributor License Agreement (CLA) signature. CLA signature is required for any code contributions to AngularJS. Please sign our CLA and ensure that the CLA signature email address and the email address in this PR's commits match. If you signed the CLA as a corporation, please let us know the company's name. Thanks a bunch! PS: If you signed the CLA in the past then most likely the email addresses don't match. Please sign the CLA again or update the email address in the commit of this PR. |
@mary-poppins signed CLA submitted |
"We suggest .... [JSONLint.com]" is kind of an endorsement, I'm not sure if it's okay to add such an endorsement or not. This could be written in a more neutral way, like "NOTE: Validating your JSON data with a JSON validator will ensure that it can be parsed correctly." or something. |
02dc2aa
to
fd2d6c0
Compare
@mary-poppins I have updated the commit with my primary GitHub email address visible. I have previously signed the CLA a few days ago with this same email address. |
Modified contents of the proposed Note, incorporating feedback from @caitp
cad9560
to
f294244
Compare
abdaab7
to
30996f8
Compare
cla verified |
why do we need to talk about linting of json payloads at all? IMO it's not within the scope of the tutorial. |
thanks for the PR but I don't think our tutorial is the right place for this kind of advice since the readers are not actually modifying the JSON payload. |
@IgorMinar I agree with your comments and I don't have any issues with you closing the PR, but like I said, the main motivation behind this PR was to try and improve the experience for other new users to AngularJS, and I felt that a simple neutral note like the one suggested by @caitp (highlighting the best practice of validating their JSON data with a JSON validator) would be perceived positively as a centralised value add, allowing them to focus on further using and promoting the framework more broadly beyond just the tutorial, and without getting stuck trying to solve silly JSON parse errors along their journey. |
there is a lot people are taking in while going through the tutorial, On Thu, Oct 9, 2014 at 12:54 PM, Luke Schoen notifications@github.com
|
agreed |
Added suggestion to use JSONLint to validate the JSON file and identify errors. It is simpler to address JSON errors independently of other errors at compile-time.
Motivation was based on personal experience following an applied version of Step 5 of the AngularJS Tutorial using Ionic and incorrectly placing a semi-colon at the end of the JSON file, such that both of the following approaches resulted in errors and data was not displayed in the browser:
Solution to the problem (i.e. using JSONLint that identified the incorrectly used semi-colon in the JSON file) was found thanks to a response to my StackOverflow post Here