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

Assert: Minor cleanup for QUnit.assert documentation #78

Closed
wants to merge 2 commits into from
Closed

Assert: Minor cleanup for QUnit.assert documentation #78

wants to merge 2 commits into from

Conversation

JamesMGreene
Copy link
Member

Some minor cleanup of the wording for QUnit.assert.

@jzaefferer
Copy link
Member

That still sounds wrong. Aren't we passing an instance?

@JamesMGreene
Copy link
Member Author

Aren't we passing an instance?

That's not 100% accurate either. It is an instance but not an instance of QUnit.assert: QUnit.assert is the prototype of the constructor that gets instantiated. I doubt we want to go into that much detail in the documentation, so we can just pick a phrase that is mostly correct but much shorter: either "copy of" or "instance of" would be fine by me but the current text is definitely not right.

@jzaefferer
Copy link
Member

I prefer "instance of" over "copy of". We could also add another paragraph that has a more accurate description for anyone interested.

Also dropped mention of QUnit.asyncTest.
@JamesMGreene
Copy link
Member Author

Updated with "instance of". Chose not to add another paragraph qualifying that further... they can look at the code if they want to know the nitty gritty details like that, I figure.

I also dropped the reference to QUnit.asyncTest as that is now deprecated.

@leobalter
Copy link
Member

👍 (LGTM)

@@ -4,7 +4,7 @@
<title>QUnit.assert</title>
<desc>Namespace for QUnit assertions</desc>
<longdesc>
<p>QUnit's built-in assertions are defined on the <code>QUnit.assert</code> object. This object is passed as the only argument to the <code>test</code> and <code>asyncTest</code> function.</p>
<p>QUnit's built-in assertions are defined on the <code>QUnit.assert</code> object. An instance of this object is passed as the only argument to the <code>QUnit.test</code> function callbacks.</p>
Copy link
Member

Choose a reason for hiding this comment

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

Why is "callbacks" in plural?

@jzaefferer
Copy link
Member

Turned that "callbacks" into singular "callback", squashed and merged.

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.

None yet

3 participants