docs(testing): tech edits #3269

kapunahelewong · 2017-02-17T18:42:28Z

These are copy related tech edits.

wardbell

I know this took a lot of work and you did well. Please make the changes I've noted here and then I'll be happy to merge it.

wardbell · 2017-02-17T18:53:13Z

public/docs/ts/latest/guide/testing.jade

    - [_triggerEventHandler_](#trigger-event-handler)
  * [Test a component inside a test host component](#component-inside-test-host)
  <br><br>  
  * [Test a routed component](#routed-component)
-    - [The _inject_ helper](#inject)
+    - [The _inject_ function](#inject)


Prefer

The inject helper function

wardbell · 2017-02-17T23:09:16Z

public/docs/ts/latest/guide/testing.jade

@@ -164,7 +181,7 @@ table(width="100%")
        End-to-end tests explore the application _as users experience it_.
        In e2e testing, one process runs the real application
        and a second process runs protractor tests that simulate user behavior 
-        and assert that the application responds in the browser as expected.
+        and assert that the application respond in the browser as expected.


Please roll this back. "Responds" is correctly plural. It is the application that responds, not the tests. Please fix.

It should only have an "s" in the indicative though, not in the subjunctive. The subjunctive here is required by "assert", which introduces the subordinate clause of expectation: "that the application respond" and the change of subject. It is the same construction as "She insists that he see a doctor." An alternative in English, which usually obscures the subjunctive, is "She wants him to see a doctor." If the first clause and second clause have different subjects and there is doubt, disbelief, denial, or imposition of will (under which expectation falls), the second clause must use the subjunctive. So you get things like:

Mom expects that he eat his lunch.
The law requires that the school have a reading program.

@wardbell I hope you read that in Leonard Nimoy's voice.

wardbell · 2017-02-17T23:10:43Z

public/docs/ts/latest/guide/testing.jade

@@ -229,30 +246,31 @@ a#1st-karma-test
 :marked
  **Put spec files somewhere within the `src/app/` folder.**
  The `karma.conf.js` tells karma to look for spec files there,
-  for reasons explained [below](#q-spec-file-location).
+  for reasons explained [later](#q-spec-file-location).


Really? "later" is better than "below". Whatever.

You made me laugh. I changed it back. Below sounds more natural and lets you know it's in the same page.

wardbell · 2017-02-17T23:12:09Z

public/docs/ts/latest/guide/testing.jade

-  ### Run karma
-  Compile and run it in karma from the command line with this command:
+  ### Run with karma
+  Compile and run it in `karma` from the command line using the following command:


It should be just karma, or maybe karma, but not karma. We're talking about the program called karma, not a class or command. Please fix.

Done. Thank you for the clarification.

wardbell · 2017-02-17T23:12:45Z

public/docs/ts/latest/guide/testing.jade

 code-example(format="." language="bash").
  npm test
 :marked
-  The command compiles the application and test code and starts karma.
+  The command compiles the application and test code and starts `karma`.


Please replace all instances of karma with karma or karma.

wardbell · 2017-02-18T02:10:26Z

public/docs/ts/latest/guide/testing.jade

        tend to keep it `false`. 

-        Calls `detectChanges` immediately which detects existing changes
-        and will trigger `ngOnInit` if the component has not yet been initialized.
+        Calls `detectChanges` immediately, which detects existing changes


Delete this sentence. I moved the sense of it up above.

wardbell · 2017-02-18T02:12:37Z

public/docs/ts/latest/guide/testing.jade

-        When autodetect is true, the test fixture listens for _zone_ events and calls `detectChanges`. 
-        You probably still have to call `fixture.detectChanges` to trigger data binding updates 
-        when your test code modifies component property values directly.
+        When autodetect is `true`, the test fixture listens for _zone_ events and calls `detectChanges`. 


When autodetect is true, the test fixture calls detectChanges immediately after creating the component. Then it listens for pertinent zone events and calls detectChanges accordingly.

wardbell · 2017-02-18T02:14:47Z

public/docs/ts/latest/guide/testing.jade

@@ -2247,21 +2344,16 @@ a(href="#top").to-top Back to top

 a#setup-files
 :marked
-  ## Setup files
-  Many think writing tests is fun. 


One of my favorite introductions ever. Sorry to see it go. But go it must.

wardbell · 2017-02-18T02:16:51Z

public/docs/ts/latest/guide/testing.jade

@@ -2295,7 +2387,7 @@ table(width="100%")
        [SystemJS](https://github.com/systemjs/systemjs/blob/master/README.md) 
        loads the application and test files.
        This script tells SystemJS where to find those files and how to load them.
-        It's the same version of `systemjs.config.js` used by Setup-based applications.
+        It's the same version of `systemjs.config.js` used by setup-based applications.


It's the same version of systemjs.config.js you installed during setup.

wardbell · 2017-02-18T02:17:44Z

public/docs/ts/latest/guide/testing.jade

-  as the application source code files that they test because
-  - Such tests are easy to find
-  - You see at a glance if a part of our application lacks tests.
+  as the application source code files that they test because:


that they test:

Drop "because"

Done. Also noticed that that sentence started with "We". Fixed that, too.

googlebot added the CLA: yes label Feb 17, 2017

wardbell suggested changes Feb 18, 2017

View reviewed changes

wardbell force-pushed the wong-testing branch from eab98fc to da62f4e Compare February 18, 2017 02:26

kapunahelewong force-pushed the wong-testing branch from da62f4e to a9935a6 Compare February 20, 2017 14:47

kapunahelewong added 3 commits February 20, 2017 10:56

docs(testing): tech edits

ad90f13

docs(testing): fix whitespace errors

4868bdf

docs(testing): update with Ward's comments

4816416

kapunahelewong force-pushed the wong-testing branch from a9935a6 to 4816416 Compare February 20, 2017 17:47

wardbell approved these changes Feb 20, 2017

View reviewed changes

wardbell merged commit 894ff63 into angular:master Feb 20, 2017

wardbell deleted the wong-testing branch February 20, 2017 23:29

docs(testing): tech edits #3269

docs(testing): tech edits #3269

Uh oh!

Conversation

kapunahelewong commented Feb 17, 2017

Uh oh!

wardbell left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

wardbell Feb 18, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

wardbell Feb 18, 2017 •

edited

Loading