LivingShadow has uploaded a new change for review.

  https://gerrit.wikimedia.org/r/71337


Change subject: RepoApi.js: Links to documentation added.
......................................................................

RepoApi.js: Links to documentation added.

Change-Id: Ie0227d82592752da7335316aa3392967317d333d
Also: Changed «snaks» to «snak's» where not plural but genitive.
---
M lib/resources/wikibase.RepoApi/wikibase.RepoApi.js
1 file changed, 7 insertions(+), 3 deletions(-)


  git pull ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/Wikibase 
refs/changes/37/71337/1

diff --git a/lib/resources/wikibase.RepoApi/wikibase.RepoApi.js 
b/lib/resources/wikibase.RepoApi/wikibase.RepoApi.js
index 461c862..b971ddb 100644
--- a/lib/resources/wikibase.RepoApi/wikibase.RepoApi.js
+++ b/lib/resources/wikibase.RepoApi/wikibase.RepoApi.js
@@ -21,6 +21,11 @@
 /**
  * Constructor to create an API object for interaction with the repo Wikibase 
API.
  *
+ * Documentation can be found
+ * – in the generated API (api.php). Valid values are listed there, for 
example for the createClaim's snaktype parameter
+ *   on <api.php?action=help&modules=wbcreateclaim> or entity types for 
createEntity (wbeditentity module).
+ * – on mediawiki.org with some usage examples: 
https://www.mediawiki.org/wiki/Extension:Wikibase/API
+ *
  * @constructor
  * @since 0.4 (since 0.3 as wb.Api without support for client usage)
  */
@@ -39,7 +44,6 @@
         * Creates a new entity with the given type and data.
         *
         * @param {String} type The type of the entity that should be created.
-        *                      Currently supported types: item|property|query
         * @param {Object} [data] The entity data (may be omitted to create an 
empty entity)
         * @return {jQuery.Promise}
         */
@@ -219,7 +223,7 @@
         * @param {String} entityId Entity id
         * @param {Number} baseRevId revision id
         * @param {string} snaktype The type of the snak
-        * @param {string} property Id of the snaks property
+        * @param {string} property Id of the snak's property
         * @param {object} value The value to set the datavalue of the the main 
snak of the claim to
         * @return {jQuery.Promise}
         */
@@ -258,7 +262,7 @@
         * @param {String} claimGuid The GUID of the Claim to be changed 
(wb.Claim.getGuid)
         * @param {Number} baseRevId
         * @param {string} snaktype The type of the snak
-        * @param {string} property Id of the snaks property
+        * @param {string} property Id of the snak's property
         * @param {object} value The value to set the datavalue of the the main 
snak of the claim to
         * @return {jQuery.Promise}
         */

-- 
To view, visit https://gerrit.wikimedia.org/r/71337
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings

Gerrit-MessageType: newchange
Gerrit-Change-Id: Ie0227d82592752da7335316aa3392967317d333d
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/Wikibase
Gerrit-Branch: master
Gerrit-Owner: LivingShadow <[email protected]>

_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits

Reply via email to