Jump to content

Talk:Gadget kitchen/January 2012 training

Add topic
From mediawiki.org
Latest comment: 13 years ago by Sumanah in topic Want more exercises

Self-generated documentation for JavaScript modules

[edit]

Copied from the talk notes:

TODO: DKinzler: would be awesome if mw.* would be self-descriptive. mw.help .... or documentation

The current status quo is to document inline with Doxygen-like formatting. This is good for programmers in contact with those files, but for online access we have yet to find a good parser that understands JavaScript and can read the various files / modules and understand which objects extend eachother, what scopes exists etc. (like is done for PHP code at http://svn.wikimedia.org/docs/). Until that is figured out, we're manually documenting things at ResourceLoader/Default modules. Also Requests for comment/Documentation overhaul. Krinkle 11:49, 22 January 2012 (UTC)Reply

Want more exercises

[edit]

Brion says:

I'd love to have maybe a few example things to do (instead of just the one) which could be useful for more hands-on "ok now you try it" and test em. [During the event] we had people poking at pages but didn't have a chance to give them feedback Sumana Harihareswara, Wikimedia Foundation Volunteer Development Coordinator 00:56, 9 February 2012 (UTC)Reply