Skip to content
This repository was archived by the owner on Jul 6, 2021. It is now read-only.

API: Documents QUnit.skip#77

Closed
leobalter wants to merge 3 commits intoqunitjs:masterfrom
leobalter:75-skip
Closed

API: Documents QUnit.skip#77
leobalter wants to merge 3 commits intoqunitjs:masterfrom
leobalter:75-skip

Conversation

@leobalter
Copy link
Copy Markdown
Member

@leobalter leobalter added this to the 1.16 milestone Sep 11, 2014
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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().

@jzaefferer
Copy link
Copy Markdown
Member

Cross-repo references need to use "[user]/[repo]#[issue]", for example "Ref qunitjs/qunit#652"

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe this line should be:

<argument name="test" type="Function" optional="true">

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's remove it entirely, that would reflect the actual implementation.

@leobalter
Copy link
Copy Markdown
Member Author

some changes applied.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about "ignoring the callback argument"

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also "Use this method to replace QUnit.test instead of commenting out entire tests." (make the reference a link)

@jzaefferer
Copy link
Copy Markdown
Member

👍

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Development

Successfully merging this pull request may close these issues.

Document QUnit.skip

3 participants