jenkins-bot has submitted this change and it was merged.
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(-)
Approvals:
Krinkle: Looks good to me, approved
jenkins-bot: Verified
diff --git a/modules/ve/dm/ve.dm.Transaction.js
b/modules/ve/dm/ve.dm.Transaction.js
index 279efa6..4524fce 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: merged
Gerrit-Change-Id: I019b0ef9c75ff47fc0f2df8c95da9d090710a5a8
Gerrit-PatchSet: 3
Gerrit-Project: mediawiki/extensions/VisualEditor
Gerrit-Branch: master
Gerrit-Owner: Cscott <[email protected]>
Gerrit-Reviewer: Catrope <[email protected]>
Gerrit-Reviewer: Krinkle <[email protected]>
Gerrit-Reviewer: jenkins-bot
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
