docs(tutorial/6 - Two-way Data Binding): fix exp. documentation #16781

anthonyx · 2018-12-03T23:37:12Z

What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)

Documentation update in step 6 of the PhoneCat Tutorial for AngularJS

What is the current behavior? (You can also link to an open issue here)

In the Experiments section of step 6 in AngularJS Tutorial, it is suggested to add a - symbol to <option value="age">Oldest</option>

This change is made to reverse the sort order when selecting the age option.

However, this change affects the default $ctrl.orderProp that we had set in app/phone-list/phone-list.component.js

After making the change, our default "Sort by" option is blank

What is the new behavior (if this is a feature change)?

I added additional documentation to clarify that this behavior makes sense and that the reader should try and correct the incorrect default behavior within app/phone-list/phone-list.component.js

Does this PR introduce a breaking change?

No

Let me know if this makes sense or if there's anything I can do to help improve the fix.
Thank you!

Please check if the PR fulfills these requirements

The commit message follows our guidelines
~~[ ] Fix/Feature: Docs have been added/updated~~
~~[ ] Fix/Feature: Tests have been added; existing tests pass~~

Other information:

In the experiments section, it is suggested to add a `-` symbol to `<option value="age">Oldest</option>` This change is made to reverse the sort order when selecting the "age" option. However, this change affects the default $ctrl.orderProp that we had set in app/phone-list/phone-list.component.js After making the change, our default when refreshing the page is "Sort by: [blank]" I added some additional documentation to clarify that this behavior makes sense and that the reader should try and fix this within phone-list.component.js Let me know if this makes sense or if there's anything I can do to help improve the fix. Thank you!

googlebot · 2018-12-03T23:37:15Z

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

📝 Please visit https://cla.developers.google.com/ to sign.

Once you've signed (or fixed any issues), please reply here (e.g. I signed it!) and we'll verify it.

What to do if you already signed the CLA

Individual signers

It's possible we don't have your GitHub username or you're using a different email address on your commit. Check your existing CLA data and verify that your email is set on your git commits.

Corporate signers

Your company has a Point of Contact who decides which employees are authorized to participate. Ask your POC to be added to the group of authorized contributors. If you don't know who your Point of Contact is, direct the Google project maintainer to go/cla#troubleshoot (Public version).
The email used to register you as an authorized contributor must be the email used for the Git commit. Check your existing CLA data and verify that your email is set on your git commits.
The email used to register you as an authorized contributor must also be attached to your GitHub account.

googlebot · 2018-12-03T23:37:15Z

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

📝 Please visit https://cla.developers.google.com/ to sign.

Once you've signed (or fixed any issues), please reply here (e.g. I signed it!) and we'll verify it.

What to do if you already signed the CLA

Individual signers

It's possible we don't have your GitHub username or you're using a different email address on your commit. Check your existing CLA data and verify that your email is set on your git commits.

Corporate signers

Your company has a Point of Contact who decides which employees are authorized to participate. Ask your POC to be added to the group of authorized contributors. If you don't know who your Point of Contact is, direct the Google project maintainer to go/cla#troubleshoot (Public version).
The email used to register you as an authorized contributor must be the email used for the Git commit. Check your existing CLA data and verify that your email is set on your git commits.
The email used to register you as an authorized contributor must also be attached to your GitHub account.

anthonyx · 2018-12-03T23:39:13Z

I signed it! Signed the CLA

googlebot · 2018-12-03T23:39:17Z

CLAs look good, thanks!

googlebot · 2018-12-03T23:39:17Z

CLAs look good, thanks!

gkalpak

Good catch 👍
I have left some minor comments.

gkalpak · 2018-12-04T09:04:40Z

docs/content/tutorial/step_06.ngdoc

@@ -230,6 +230,9 @@ You can now rerun `npm run protractor` to see the tests run.

 * Reverse the sort order by adding a `-` symbol before the sorting value:
  `<option value="-age">Oldest</option>`
+  Upon refreshing the page, you'll see that the default selection of the "age" option in "Sort by" is blank again.
+  Try fixing this in **`app/phone-list/phone-list.component.js`:**
+


Right, deleted the extra line. Fixed in 41e28b6

gkalpak · 2018-12-04T09:06:50Z

docs/content/tutorial/step_06.ngdoc

@@ -230,6 +230,9 @@ You can now rerun `npm run protractor` to see the tests run.

 * Reverse the sort order by adding a `-` symbol before the sorting value:
  `<option value="-age">Oldest</option>`
+  Upon refreshing the page, you'll see that the default selection of the "age" option in "Sort by" is blank again.
+  Try fixing this in **`app/phone-list/phone-list.component.js`:**


There is a redundand : after the filename and the . is missing at the end of the sentence.
I would also change wrap the filename in ` instead of ** for consistency.

I've deleted the redundant : and also added the . at the end of the sentence. Fixed the filename wrap as well. Fixed in 41e28b6

gkalpak · 2018-12-04T09:13:48Z

docs/content/tutorial/step_06.ngdoc

@@ -230,6 +230,9 @@ You can now rerun `npm run protractor` to see the tests run.

 * Reverse the sort order by adding a `-` symbol before the sorting value:
  `<option value="-age">Oldest</option>`
+  Upon refreshing the page, you'll see that the default selection of the "age" option in "Sort by" is blank again.


I would rephrase this to something like:

You'll notice that the default ordering by age does not work any more and the drop-down list has a blank option selected.
Fix this, by updating the orderProp value in phone-list.component.js to match the new value on the <option> element.

I updated the documentation to more closely follow your suggested change. Thank you for improving the clarity! Fixed in 41e28b6

In the experiments section, it is suggested to add a `-` symbol to `<option value="age">Oldest</option>`. This change is made to reverse the sort order when selecting the `age` option. However, this change affects the default `$ctrl.orderProp` that we had set in `phone-list.component.js`. After making the change, our default when refreshing the page is "Sort by: [blank]". This commit adds some additional documentation to clarify that this behavior makes sense and that the reader should try and fix this within `phone-list.component.js`. Closes #16781

googlebot added the cla: no label Dec 3, 2018

googlebot added cla: yes and removed cla: no labels Dec 3, 2018

gkalpak reviewed Dec 4, 2018

View reviewed changes

anthonyx changed the title ~~docs(tutorial/6 - Two-way Data Binding): Fixed Experiments Documentation~~ docs(tutorial/6 - Two-way Data Binding): fix exp. documentation Dec 5, 2018

Update step_06.ngdoc

41e28b6

gkalpak approved these changes Dec 5, 2018

View reviewed changes

gkalpak closed this in fa8fe1f Dec 5, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

docs(tutorial/6 - Two-way Data Binding): fix exp. documentation #16781

docs(tutorial/6 - Two-way Data Binding): fix exp. documentation #16781

Uh oh!

anthonyx commented Dec 3, 2018

Uh oh!

googlebot commented Dec 3, 2018

Uh oh!

googlebot commented Dec 3, 2018

Uh oh!

anthonyx commented Dec 3, 2018

Uh oh!

googlebot commented Dec 3, 2018

Uh oh!

googlebot commented Dec 3, 2018

Uh oh!

gkalpak left a comment

Uh oh!

gkalpak Dec 4, 2018

Uh oh!

anthonyx Dec 5, 2018

Uh oh!

gkalpak Dec 4, 2018

Uh oh!

anthonyx Dec 5, 2018

Uh oh!

gkalpak Dec 4, 2018

Uh oh!

anthonyx Dec 5, 2018

Uh oh!

Uh oh!

docs(tutorial/6 - Two-way Data Binding): fix exp. documentation #16781

docs(tutorial/6 - Two-way Data Binding): fix exp. documentation #16781

Uh oh!

Conversation

anthonyx commented Dec 3, 2018

Uh oh!

googlebot commented Dec 3, 2018

What to do if you already signed the CLA

Individual signers

Corporate signers

Uh oh!

googlebot commented Dec 3, 2018

What to do if you already signed the CLA

Individual signers

Corporate signers

Uh oh!

anthonyx commented Dec 3, 2018

Uh oh!

googlebot commented Dec 3, 2018

Uh oh!

googlebot commented Dec 3, 2018

Uh oh!

gkalpak left a comment

Choose a reason for hiding this comment

Uh oh!

gkalpak Dec 4, 2018

Choose a reason for hiding this comment

Uh oh!

anthonyx Dec 5, 2018

Choose a reason for hiding this comment

Uh oh!

gkalpak Dec 4, 2018

Choose a reason for hiding this comment

Uh oh!

anthonyx Dec 5, 2018

Choose a reason for hiding this comment

Uh oh!

gkalpak Dec 4, 2018

Choose a reason for hiding this comment

Uh oh!

anthonyx Dec 5, 2018

Choose a reason for hiding this comment

Uh oh!

Uh oh!