Page MenuHomePhabricator

OOUI Documentation: ClippableElement: Fix typo in #$element
Closed, DeclinedPublic

Description

Skills

JavaScript / JSDoc◾️◾️◽️◽️◽️

$element is not a link and should not have the preceding #

Event Timeline

Change 478386 had a related patch set uploaded (by Zoranzoki21; owner: Zoranzoki21):
[mediawiki/core@master] Fix typo "#$element" in the OOUI Documentation

https://gerrit.wikimedia.org/r/478386

Change 478386 abandoned by Zoranzoki21:
Fix typo "#$element" in the OOUI Documentation

Reason:
Will be done in oojs/ui (if I find this typo there)

https://gerrit.wikimedia.org/r/478386

Change 479269 had a related patch set uploaded (by Zoranzoki21; owner: Zoranzoki21):
[oojs/ui@master] Fix typo "#$element" in the OOUI Documentation

https://gerrit.wikimedia.org/r/479269

Why is $element not a link? I note on https://doc.wikimedia.org/oojs-ui/master/js/#!/api/OO.ui.mixin.ClippableElement that $clippable and $clippableContainer are links. Shouldn't we be fixing $element to be a link, rather than unlinking it?

@Prtksxna JSDoc is continuing to support those links?

Why is $element not a link? I note on https://doc.wikimedia.org/oojs-ui/master/js/#!/api/OO.ui.mixin.ClippableElement that $clippable and $clippableContainer are links. Shouldn't we be fixing $element to be a link, rather than unlinking it?

I thought so as well, but wasn't sure (still not) where it should link to… https://doc.wikimedia.org/oojs-ui/master/js/#!/api/OO.ui.Element-cfg-S-element?

Kizule removed Kizule as the assignee of this task.Jan 3 2019, 2:41 PM
Kizule removed projects: Patch-For-Review, User-Kizule.
Kizule subscribed.
Kizule unsubscribed.

I am not sure what I should do, so I removed assignee to me.

Change 479269 abandoned by Zoranzoki21:
Fix typo "#$element" in the OOUI Documentation

https://gerrit.wikimedia.org/r/479269

Volker_E removed a project: Google-Code-in-2018.
Volker_E added a subscriber: Kizule.

Without further clarification 'declined' as is.
Thanks @Zoranzoki21 for your attempt on this though!