API: Documents QUnit.skip #77
Conversation
| </argument> | ||
| </signature> | ||
| <desc> | ||
| Add a WIP test, it will be skipped and will also ignore any hooks. |
There was a problem hiding this comment.
Let's not use abbreviations like "WIP" in documentation. This also needs some explanation of why anyone would use this method, along with a two way reference to QUnit.test().
|
Cross-repo references need to use "[user]/[repo]#[issue]", for example "Ref qunitjs/qunit#652" |
| <argument name="name" type="String"> | ||
| <desc>Title of unit being tested</desc> | ||
| </argument> | ||
| <argument name="test"> |
There was a problem hiding this comment.
I believe this line should be:
<argument name="test" type="Function" optional="true">There was a problem hiding this comment.
We could also make it more explicit like QUnit.test's documentation were we document the Function format but that would be kind of ironic since we totally disregard the function passed in anyway.
There was a problem hiding this comment.
Let's remove it entirely, that would reflect the actual implementation.
|
some changes applied. |
| Adds a test like object to be skipped | ||
| </desc> | ||
| <longdesc> | ||
| <p>This test's prototype will be listed on the suite as a skipped test, ignoring a giving callback function and the respective global and module's hooks.</p> |
There was a problem hiding this comment.
How about "ignoring the callback argument"
There was a problem hiding this comment.
Also "Use this method to replace QUnit.test instead of commenting out entire tests." (make the reference a link)
|
👍 |
Fixes #75
Ref qunitjs/qunit#637
Ref qunitjs/qunit#652