https://bugzilla.wikimedia.org/show_bug.cgi?id=23461
Summary: Normalise usage of parameter names in parameter
descriptions
Product: MediaWiki
Version: unspecified
Platform: All
OS/Version: All
Status: NEW
Severity: trivial
Priority: Normal
Component: API
AssignedTo: [email protected]
ReportedBy: [email protected]
CC: [email protected], [email protected],
[email protected], [email protected]
Per irc, we should normalise the style. In this case, it seems appending the
module prefix is probably better.
Some are hardcoded with the prefix, some use fields etc.
<Reedy> RoanKattouw, in ApiQueryRevisions, we use the literal rvsections in a
description... Every other param references is minus prefix... Presume it
should be removed?
<RoanKattouw> This is probably inconsistent across the API as well. Let's pick
one and stick with it
<Reedy> it's that, or do something with a prefux
<RoanKattouw> Maybe see which style is the most frequently used one. I have no
idea
<Reedy> RoanKattouw, I suspect, if we're going to normalise it to using the
prefix, we shouldn't hard code in.. Incase we inherit from modules etc etc?
<RoanKattouw> Reedy: Yes, and for multi-mode modules. So that means
{$this->getModulePrefix()} or whatever the name is all over
<RoanKattouw> See ApiQueryBacklinks
<Reedy> Mmmm
<RoanKattouw> Or do $p = $this->getModulePrefix(); and use {$p} , probably
nicer
--
Configure bugmail: https://bugzilla.wikimedia.org/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are on the CC list for the bug.
_______________________________________________
Wikibugs-l mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/wikibugs-l
