Henning Snater has uploaded a new change for review.
https://gerrit.wikimedia.org/r/173832
Change subject: Updated documentation in snakview.variations.Variation
......................................................................
Updated documentation in snakview.variations.Variation
Change-Id: Ie234a96ce8620813956ad98695cbe9504ddf07ae
---
M lib/resources/jquery.wikibase/snakview/snakview.variations.Variation.js
1 file changed, 13 insertions(+), 10 deletions(-)
git pull ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/Wikibase
refs/changes/32/173832/1
diff --git
a/lib/resources/jquery.wikibase/snakview/snakview.variations.Variation.js
b/lib/resources/jquery.wikibase/snakview/snakview.variations.Variation.js
index d627a14..81d7e64 100644
--- a/lib/resources/jquery.wikibase/snakview/snakview.variations.Variation.js
+++ b/lib/resources/jquery.wikibase/snakview/snakview.variations.Variation.js
@@ -128,9 +128,10 @@
* @since 0.4
*
* @param {Object} [value]
- * @return {Object|undefined} Plain Object with parts of the
Snak specific to the variation's
- * kind of Snak. Equivalent to what
wb.datamodel.Snak.toMap() would return, just without the
- * basic fields 'snaktype' and 'property'.
+ * @return {Object|undefined} Plain Object with parts of the
Snak specific to the
+ * variation's kind of Snak. Equivalent to what the
serialize() function of
+ * wb.serialization.SnakSerializer would return, just
without the basic fields
+ * 'snaktype' and 'property'.
* undefined in case value() is called to set the value.
*/
value: function( value ) {
@@ -143,11 +144,12 @@
/**
* Setter for value(). Does not trigger draw() but value( value
) will trigger draw().
* Receives an Object which holds fields of the part of the
Snak the variation is handling.
- * The fields are the same as wb.datamodel.Snak.toMap() would
provide them. The 'property' and
- * 'snaktype' fields will not be provided, they can be received
per viewState().property()
- * and viewState().snakType() if necessary. If a field is
missing, this means that the
- * aspect of the Snak has not been defined yet, the view should
then display a useful
- * message or, in edit-mode, show empty input forms for user
interaction.
+ * The fields are the same as
wb.serialization.SnakSerializer.serialize() would provide
+ * them.
+ * The 'property' and 'snaktype' fields will not be provided,
they can be received per
+ * viewState().property() and viewState().snakType() if
necessary. A missing field implies
+ * that the aspect of the Snak has not been defined yet. Then,
the view should display a
+ * useful message or, in edit-mode, show empty input forms for
user interaction.
*
* @since 0.4
*
@@ -157,8 +159,9 @@
/**
* Getter for value(). Should return the aspects of the Snak
which the variation is taking
- * care of. Should be an Object with fields as the toMap()
function of the related Snak
- * would return. For aspects of the Snak not defined yet, the
related field should hold null.
+ * care of. Should be an Object with fields as the serialize()
function of
+ * wb.serialization.SnakSerializer would return. For aspects of
the Snak not defined yet,
+ * the related field should hold null.
*
* @since 0.4
*
--
To view, visit https://gerrit.wikimedia.org/r/173832
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: Ie234a96ce8620813956ad98695cbe9504ddf07ae
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/Wikibase
Gerrit-Branch: master
Gerrit-Owner: Henning Snater <[email protected]>
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
