Page MenuHomePhabricator

Document ResourceLoaderImage module
Closed, ResolvedPublic

Description

There seems to be little documentation for ResourceLoaderImageModule and I spend a lot of time, guiding people with its usage.

https://www.mediawiki.org/wiki/ResourceLoader is very outdated...
@Spage what's the best way to work with you to flag needs for documentation?

spage is working on it in https://www.mediawiki.org/wiki/ResourceLoader/Images

Event Timeline

Jdlrobson assigned this task to Spage.
Jdlrobson raised the priority of this task from to Needs Triage.
Jdlrobson updated the task description. (Show Details)
Jdlrobson added a project: Reading-Admin.
Jdlrobson moved this task to Backlog on the Reading-Admin board.
Jdlrobson added subscribers: Jdlrobson, Florian, Spage.

what's the best way to work with you to flag needs for documentation?

add Documentation flag (done) and ping me.

The generated doxygen info is weak

  • RL PHP files should all have @ingroup ResourceLoader
  • doxygen doesn't have a collaboration diagram between this and RLImage
  • very bare bones explanation.

But ReleaseLoaderImage{,Module} are undocumented on mw.org and this is complex enough that "Images in ResourceLoader" should be, so I'll talk to you soon!

Spage added a project: ECT-August-2015.
Spage set Security to None.
Spage added a subscriber: matmarex.

Nearly done

  • move embed info to existing RL page
  • add to RL nav ?
  • review
Qgil triaged this task as High priority.Aug 25 2015, 3:57 PM
Qgil subscribed.

Sounds like High priority.

Krinkle lowered the priority of this task from High to Medium.
matmarex assigned this task to Spage.

https://www.mediawiki.org/wiki/ResourceLoader/Images exists now (mostly written by @Spage) and it seems to be an adequate description, so I'm marking this as resolved.