Permalink
Browse files

Clean up docs for callbacks, add category description. Fixes #3

  • Loading branch information...
1 parent 41cd4dd commit f68c2a2a03b831f0d71ce2cfc10b1bc097c6d513 @jzaefferer jzaefferer committed Sep 30, 2012
View
@@ -2,7 +2,12 @@
<category name="Uncategorized" slug="uncategorized"/>
<category name="Test" slug="test"></category>
<category name="Assert" slug="assert"></category>
- <category name="Callbacks" slug="callbacks"></category>
+ <category name="Callbacks" slug="callbacks">
+ <desc><![CDATA[
+ When integrating QUnit into other tools like CI servers, use these callbacks as an API to read test results.
+ <p>QUnit bundles two addons that both use these callbacks: The JUnit logger and the PhantomJS runner.</p>
+ ]]></desc>
+ </category>
<category name="Async Control" slug="async-control"></category>
<category name="Configuration" slug="config"></category>
<category name="All" slug="all"></category>
View
@@ -7,13 +7,7 @@
<desc>Callback to execute</desc>
</argument>
</signature>
- <desc>Register a callback to fired when the test suite begins.</desc>
+ <desc>Register a callback to fire whenever the test suite begins.</desc>
<longdesc><code>QUnit.begin()</code> is called once before running any tests. (a better would've been QUnit.start, but thats already in use elsewhere and can't be changed.) </longdesc>
- <example height="250">
- <desc>Register a callback that logs test results to the console.</desc>
- <code><![CDATA[
-QUnit.begin();
-]]></code>
- </example>
<category slug="callbacks"/>
</entry>
View
@@ -7,7 +7,7 @@
<argument name="details" type="Object" />
</argument>
</signature>
- <desc>Register a callback to fired when the test suite ends.</desc>
+ <desc>Register a callback to fire whenever the test suite ends.</desc>
<longdesc>
<code>QUnit.done()</code> is called whenever all the tests have finished running. <code>failed</code> is the number of failures that occurred. <code>total</code> is the total number of assertions that occurred, <code>passed</code> the passing assertions. <code>runtime</code> is the time in milliseconds to run the tests from start to finish.
</longdesc>
@@ -7,6 +7,6 @@
<desc>Callback to execute</desc>
</argument>
</signature>
- <desc>Register a callback to fired whenever a module ends.</desc>
+ <desc>Register a callback to fire whenever a module ends.</desc>
<category slug="callbacks"/>
</entry>
@@ -7,6 +7,6 @@
<desc>Callback to execute</desc>
</argument>
</signature>
- <desc>Register a callback to fired whenever a module begins.</desc>
+ <desc>Register a callback to fire whenever a module begins.</desc>
<category slug="callbacks"/>
</entry>
@@ -7,6 +7,6 @@
<desc>Callback to execute</desc>
</argument>
</signature>
- <desc>Register a callback to fired whenever a test block ends.</desc>
+ <desc>Register a callback to fire whenever a test ends.</desc>
<category slug="callbacks"/>
</entry>
@@ -7,6 +7,6 @@
<desc>Callback to execute</desc>
</argument>
</signature>
- <desc>Register a callback to fired whenever a test block begins.</desc>
+ <desc>Register a callback to fire whenever a test begins.</desc>
<category slug="callbacks"/>
</entry>
View
@@ -15,7 +15,7 @@ grunt.initConfig({
grunt: "grunt.js"
},
watch: {
- files: "entries/**",
+ files: [ "entries/**", "categories.xml" ],
tasks: "deploy"
},
xmllint: {

0 comments on commit f68c2a2

Please sign in to comment.