Last modified: 2014-10-16 15:59:12 UTC

Wikimedia Bugzilla is closed!

Wikimedia migrated from Bugzilla to Phabricator. Bug reports are handled in Wikimedia Phabricator.
This static website is read-only and for historical purposes. It is not possible to log in and except for displaying bug reports and their history, links might be broken. See T74103, the corresponding Phabricator task for complete and up-to-date bug report information.
Bug 72103 - Provide action=help entry point for all modules of an extension/group
Provide action=help entry point for all modules of an extension/group
Status: NEW
Product: MediaWiki
Classification: Unclassified
API (Other open bugs)
unspecified
All All
: Low enhancement (vote)
: ---
Assigned To: Nobody - You can work on this!
:
Depends on:
Blocks: 39480
  Show dependency treegraph
 
Reported: 2014-10-15 22:58 UTC by Nemo
Modified: 2014-10-16 15:59 UTC (History)
5 users (show)

See Also:
Web browser: ---
Mobile Platform: ---
Assignee Huggle Beta Tester: ---


Attachments

Description Nemo 2014-10-15 22:58:42 UTC
The new way to display help will greatly simplify and prettify documentation such as https://www.mediawiki.org/wiki/Help:Extension:Translate/API#Web-API

I would be even happier if https://translatewiki.net/w/api.php?action=help&modules=query+messagecollection%7Cquery+messagegroups%7Cquery+messagegroupstats%7Cquery+messagetranslations%7Ctranslationreview%7Cttmserver%7Cgroupreview and similar could be replaced by some concise alternative.

We do have $ ack "ingroup API TranslateAPI"    
ApiTranslateUser.php
14: * @ingroup API TranslateAPI
etc., but I doubt that helps anything. It would be nice if the groups could be exposed in more ways.
Comment 1 Sam Reed (reedy) 2014-10-16 13:22:40 UTC
Yeah, we'd need some functionality in the API to set a group for a module.

The @ingroup docs isn't available to the code in anyway

Shouldn't be too difficult though I don't think....
Comment 2 Brad Jorsch 2014-10-16 15:59:12 UTC
Not too difficult, but it's also likely to be somewhat poorly performing since it would require recursing through all modules and filtering by this group field.

We've long cached the old API help page for this sort of reason, and the new help page is cached too in the commonly-hit case with recursivesubmodules. We'll have to consider whether the hits to this would be uncommon enough that the performance hit wouldn't be prohibitive, or often enough that it would be worth the potentially-large number of cache entries.

Note You need to log in before you can comment on or make changes to this bug.


Navigation
Links