Topic on Project:Support desk

Extension Devs: Don't Say "bottom of localsettings.php"

4
Johnywhy (talkcontribs)

the phrase "put the declaration at the bottom of localsettings.php" is very UNhelpful, since MANY extensions say the same thing!

It's more useful to explain exactly which declares must come before the extension, such as protections, etc. Example here under Important

Or, if it doesn't matter, simply say "below the default settings".

2001:16B8:1020:6600:7C54:5D89:66FF:4271 (talkcontribs)

Developers, especially unexperienced developers often add duplicate code to LocalSettings.php. That is one of the reasons for saying "put it at the end". Then at least the newest lines are getting used.

Johnywhy (talkcontribs)

that only works until some new declaration is placed under the last one, breaking the previous one. So, doesn't really make sense.

Samwilson (talkcontribs)

Yeah, I think this is a good point!

There aren't that many extensions that care too much where they get enabled in LocalSettings. The normal case should basically be that they can be enabled wherever, and those for which it does matter should get extra documentation.

(Maybe worth posting a note to mediawiki-l?)

Reply to "Extension Devs: Don't Say "bottom of localsettings.php""