Krinkle has uploaded a new change for review. https://gerrit.wikimedia.org/r/71266
Change subject: doc: Clean up documentation in template data model ...................................................................... doc: Clean up documentation in template data model Change-Id: Iee788bc8fa6f0545085a0f154b77b8176f770dd2 --- M modules/ve/dm/models/ve.dm.MWTemplateSpecModel.js M modules/ve/ui/dialogs/ve.ui.MWTransclusionDialog.js 2 files changed, 9 insertions(+), 6 deletions(-) git pull ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/VisualEditor refs/changes/66/71266/1 diff --git a/modules/ve/dm/models/ve.dm.MWTemplateSpecModel.js b/modules/ve/dm/models/ve.dm.MWTemplateSpecModel.js index 06a2d88..3507f13 100644 --- a/modules/ve/dm/models/ve.dm.MWTemplateSpecModel.js +++ b/modules/ve/dm/models/ve.dm.MWTemplateSpecModel.js @@ -10,6 +10,9 @@ /** * MediaWiki template specification. * + * See https://raw.github.com/wikimedia/mediawiki-extensions-TemplateData/master/spec.templatedata.json + * for the latest version of the TemplateData specification. + * * @class * * @constructor @@ -33,7 +36,7 @@ * * @method * @static - * @param {string|Object|undefined} val Messsage or object with messages keyed by language + * @param {string|Object|null} val Messsage or object with messages keyed by language * @param {Mixed} [fallback=null] Value to use if message is not available * @param {string} [lang] Language to prefer, user interface language will be used by default * @returns {string} Message text or fallback if not available @@ -184,10 +187,10 @@ * * @method * @param {string} name Parameter name - * @returns {string} Parameter description + * @returns {string|null} Parameter description */ ve.dm.MWTemplateSpecModel.prototype.getParameterDescription = function ( name ) { - return this.constructor.getMessage( this.params[name].description, null ); + return this.constructor.getMessage( this.params[name].description ); }; /** @@ -252,7 +255,7 @@ * * @method * @param {string} name Parameter name - * @returns {boolean} Parameter is deprecated + * @returns {boolean|string} Parameter is deprecated */ ve.dm.MWTemplateSpecModel.prototype.isParameterDeprecated = function ( name ) { return this.params[name].deprecated; @@ -272,7 +275,7 @@ * Get parameter sets. * * @method - * @returns {string[][]} Lists of parameter sets + * @returns {Object[]} Lists of parameter set descriptors */ ve.dm.MWTemplateSpecModel.prototype.getParameterSets = function () { return this.sets; diff --git a/modules/ve/ui/dialogs/ve.ui.MWTransclusionDialog.js b/modules/ve/ui/dialogs/ve.ui.MWTransclusionDialog.js index 1583a78..f9b948a 100644 --- a/modules/ve/ui/dialogs/ve.ui.MWTransclusionDialog.js +++ b/modules/ve/ui/dialogs/ve.ui.MWTransclusionDialog.js @@ -8,7 +8,7 @@ /*global mw */ /** - * Dialog for a MediaWiki content transclusion. + * Dialog for editing a MediaWiki transclusion block. * * See https://raw.github.com/wikimedia/mediawiki-extensions-TemplateData/master/spec.templatedata.json * for the latest version of the TemplateData specification. -- To view, visit https://gerrit.wikimedia.org/r/71266 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: newchange Gerrit-Change-Id: Iee788bc8fa6f0545085a0f154b77b8176f770dd2 Gerrit-PatchSet: 1 Gerrit-Project: mediawiki/extensions/VisualEditor Gerrit-Branch: master Gerrit-Owner: Krinkle <[email protected]> _______________________________________________ MediaWiki-commits mailing list [email protected] https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
