Consider adding example to "config" keys in extension.json
Closed, DeclinedPublic
Actions

Assigned To

None

Authored By

	Legoktm
	May 12 2020, 7:40 PM

Description

From the Variables extension:

		"VariablesDisabledFunctions": {
			"value": [],
			"path": false,
			"descriptionmsg": "variables-config-disabledfunctions",
			"@example": "$egVariablesDisabledFunctions = [ 'var_final', 'vardefineecho' ]; // to disable '#var_final' and '#vardefineecho' functions",
			"public": true
		},

Is this useful for us to keep in extension.json or should we recommend that it goes on wiki pages?

Details

	Subject	Repo	Branch	Lines +/-
	Move config example to descriptionmsg	mediawiki/extensions/Variables	master	+1 -2

Customize query in gerrit

Related Objects

Mentioned In: T252589: Strengthen "config" schema validation in manifest_version 2

Event Timeline

Legoktm created this task.May 12 2020, 7:40 PM

Restricted Application added a subscriber: Aklapper. · View Herald TranscriptMay 12 2020, 7:40 PM

Legoktm mentioned this in T252589: Strengthen "config" schema validation in manifest_version 2.May 12 2020, 7:48 PM

Change 596048 had a related patch set uploaded (by Legoktm; owner: Legoktm):
[mediawiki/extensions/Variables@master] Remove example from extension.json

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

gerritbot added a project: Patch-For-Review.May 12 2020, 7:58 PM

Couldn't it simply be part of the description?

Adding documentation in a way like this is recommened in the extension registraion documentaton, which is why I added it.
Currently, it says that this is not supported for config anymore, but when I added the key, it stated otherwise.

In T252586#6131041, @Tgr wrote:

Couldn't it simply be part of the description?

That seems reasonable.

Change 596048 merged by Legoktm:
[mediawiki/extensions/Variables@master] Move config example to descriptionmsg