Links to QUnit types broken

[jonvuri]

Example: The QUnit.assert type link in the signature of QUnit.test( name, test ) on http://api.qunitjs.com/QUnit.test/. It leads to http://api.jquery.com/Types/#QUnit.assert but there is no documentation of that type there.

[JamesMGreene]

Thanks for reporting this!

Yeah, that is all around messed up... especially since it's going to the jQuery core API docs.

Correct link should be: http://api.qunitjs.com/QUnit.assert/

[JamesMGreene]

Seems that we need to override some of the base XSL templates from grunt-jquery-content. I would be surprised if this isn't causing documentation bugs in jQuery UI, Mobile, Sizzle, etc.

[leobalter]

I tried to link the assert argument to it's reference object, that is QUnit.assert. But that was wrong because that need to be exactly the JS type.

That would make sense if we already had an instantiation of QUnit's Assert, but it's not the case here.

To quick fix this I pushed #56 to set the correct type of assert.

[jonvuri]

if we already had an instantiation of QUnit's Assert

I must be misunderstanding something, because I thought this was exactly the case. That's the signature of the callback, by the time it is called QUnit.assert certainly will have been instantiated and passed to it.

[leobalter]

Yes, I explained it wrong here.

I'm just focused on qunitjs/qunit#588 and was trying to refer to that. My bad.

[jonvuri]

I'm not sure I understand the full import of that, but from an outsider's perspective it's not ideal to not have a link to QUnit.assert there. (The one you just removed in #56) That's an important link to be able to know what you can do with that object.

[leobalter]

@jzaefferer and @scottgonzalez: there's any possibility to set a custom link to custom argument types there?

@jrajav: let's see if we can improve/implement it.

[jzaefferer]

Let's put a link to the relevant page or category in the description of those methods.

[scottgonzalez]

I would be surprised if this isn't causing documentation bugs in jQuery UI, Mobile, Sizzle, etc.

Why? None of the other projects use custom types.

[scottgonzalez]

there's any possibility to set a custom link to custom argument types there?

There's no support for custom types. I've created jquery/grunt-jquery-content#54 for discussion around the idea.

[jzaefferer]

I created a follow-up ticket for this, to implement a better solution, #58.