https://bugzilla.wikimedia.org/show_bug.cgi?id=64594
Bug ID: 64594
Summary: Improve documentation of supported formats and data
structures for different data types.
Product: MediaWiki extensions
Version: unspecified
Hardware: All
OS: All
Status: NEW
Severity: normal
Priority: Unprioritized
Component: WikidataRepo
Assignee: [email protected]
Reporter: [email protected]
CC: [email protected]
Web browser: ---
Mobile Platform: ---
We currently document the structure of data values on Special:ListDatatypes.
While this is better than nothing, it's really misleading, and missing
important information. It's also nearly impossible to discover.
The relevant help page (or special page) should be linked from the API's self
documentation, and from the relevant error messages shown to the user.
The documentation on Special:ListDatatypes should include, for each data type:
* Supported plain string representations (this info must be supplied be the
parser). This is the relevant information for people interacting with the UI
directly.
* The data value type, and the JSON structure used to represent the data value.
* Semantics of the individual fields of the JSON structure.
* Constraints imposed by the data value's validators (should be provided by the
data type factory).
--
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
