https://bugzilla.wikimedia.org/show_bug.cgi?id=34967
Web browser: ---
Bug #: 34967
Summary: FeaturedFeeds API documentation is unclear
Product: MediaWiki extensions
Version: any
Platform: All
OS/Version: All
Status: NEW
Severity: normal
Priority: Unprioritized
Component: FeaturedFeeds
AssignedTo: maxsem.w...@gmail.com
ReportedBy: b...@mzmcbride.com
Classification: Unclassified
Mobile Platform: ---
The current documentation for action=featuredfeeds reads:
---
* action=featuredfeed *
Returns a user contributions feed
This module requires read rights
Parameters:
feedformat - The format of the feed
One value: rss, atom
Default: rss
feed - Feed name
This parameter is required
One value:
language - Feed language code. Ignored by some feeds.
Examples:
Retrieve feed `featured'
api.php?action=featuredfeed&feed=featured
---
I find this documentation incredibly confusing.
First, "Returns a user contributions feed". Is this true? You're not inputting
a username or user ID to get a list of contributions, so this seems to be at
least misleading.
Second, the "feed" parameter is associated with some kind of magical "Feed
name". It's a required parameter without a default (apparently) and the
possible values are... null (though it only takes one!).
Third, the "language" parameter doesn't specify what kind of language code
you're looking for. Two letters? Three letters?
The example also doesn't really make much sense to me, though perhaps I'm just
being thick.
--
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
Wikibugs-l@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/wikibugs-l
