Document QUnit.push

[jugglinmike]

Since this functionality is backed with unit tests, I thought it could use some documentation.

This commit adds a new category, so I expect this will also require a change to the qunit.js site itself, but I'm not really sure how to orchestrate that. Alternatively, we could add this new entry to the "Configuration" category (although I would argue the discoverability of that approach).

Issue #17 sounds like it could be related. @jzaefferer: are "addons" equivalent to custom assertions?

[jzaefferer]

Thanks for the contribution! Could you update your git.user config to match the name with which you signed our CLA (Michael Pennisi)?

I'm not sure about the category name. Since there's more entries to add, we can probably figure out the naming at once: This also partially addresses qunitjs/qunitjs.com#54

Would be great if you could create the other two API entries, QUnit.assert and QUnit.extend, as well. Thanks!

[jugglinmike]

Sure thing @jzaefferer --I'll get on this asap.

Regarding the signature: I've already contributed to a few jQuery projects as "Mike", so I'll see what I can do about updating my name on the CLA.

[jugglinmike]

Alright @jzaefferer I've added a draft for the API docs you've requested. I'm not sure about the best way to document QUnit.assert. I've just copied over the short descriptions from the relevant entry pages, but this doesn't seem particularly maintainable. Do you have any thoughts on this?

I assume you'll want to publish these entries before the update to the "Cookbook" documentation. Is this the case?

[jugglinmike]

Also: I've specified the "config" category for each of the three new pages.

[jzaefferer]

Thanks for the updates, looking good!

As for the CLA: I've updated to your name there to 'Mike', so that should be fine now.

When exactly we publish these updates isn't that important. It would be good to have a PR for the cookbook update before landing this - I can test both together locally. Would you work on the cookbook update as well?

[jugglinmike]

Sure thing

[jugglinmike]

Hi @jzaefferer:

Is there anything else that needs to be done now that I've opened qunitjs/qunitjs.com#55 ?

[JamesMGreene]

Looks good to me so far as I can tell in XML format. 👍 I'd be willing to take another look once it moves to the staging or main site, too, though (@jzaefferer).

[jzaefferer]

I just deployed this and the cookbook update on stage, so http://stage.qunitjs.com/cookbook/#custom-assertions

Looking at that, we should add links in the new cookbook section to the entries that this PR adds, like http://stage.api.qunitjs.com/QUnit.assert/ (exclude stage from the URL).

[jugglinmike]

Alrighty @jzaefferer I've updated qunitjs/qunitjs.com#55 as per your request.

[jzaefferer]

Thanks Mike! I've landed this, though I updated the QUnit.assert page in 01862fb.

[jugglinmike]

Great :)