Cscott has uploaded a new change for review.

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


Change subject: Minor doc fixes to `ve.dm.Transaction`.
......................................................................

Minor doc fixes to `ve.dm.Transaction`.

Correct the return value descriptions for the `newFromMetadataInsertion` and
`newFromMetadataRemoval` methods (which appear to have been cut-and-pasted
from another method).

Change-Id: I019b0ef9c75ff47fc0f2df8c95da9d090710a5a8
---
M modules/ve/dm/ve.dm.Transaction.js
1 file changed, 2 insertions(+), 2 deletions(-)


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

diff --git a/modules/ve/dm/ve.dm.Transaction.js 
b/modules/ve/dm/ve.dm.Transaction.js
index 22f3fe7..25dc08a 100644
--- a/modules/ve/dm/ve.dm.Transaction.js
+++ b/modules/ve/dm/ve.dm.Transaction.js
@@ -331,7 +331,7 @@
  * @param {ve.dm.Document} doc Document to create transaction for
  * @param {number} offset Offset of element
  * @param {ve.Range} range Range of metadata to remove
- * @returns {ve.dm.Transaction} Transaction that removes data
+ * @returns {ve.dm.Transaction} Transaction that removes metadata elements
  * @throws {Error} Cannot remove metadata from empty list
  * @throws {Error} Range out of bounds
  */
@@ -375,7 +375,7 @@
  * @param {number} offset Offset of element
  * @param {number} index Index of metadata cursor within element
  * @param {Object} newElement New element to insert
- * @returns {ve.dm.Transaction} Transaction that removes data
+ * @returns {ve.dm.Transaction} Transaction that replaces a metadata element
  * @throws {Error} Metadata index out of bounds
  */
 ve.dm.Transaction.newFromMetadataElementReplacement = function ( doc, offset, 
index, newElement ) {

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

Gerrit-MessageType: newchange
Gerrit-Change-Id: I019b0ef9c75ff47fc0f2df8c95da9d090710a5a8
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/VisualEditor
Gerrit-Branch: master
Gerrit-Owner: Cscott <[email protected]>

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

Reply via email to