Extension talk:Scribunto/Documentation specification

From mediawiki.org


The template documentation system is pretty good--basically, there's a subpage of whatever Template you're accessing, called "Template:TplName/Doc", where the docs are stored. Well, we could easily have something similar. So either

  1. Use a subpage named "Module:ModuleName/Doc", EXACTLY like we would have for the Template that we're replacing. Auto-transclude that puppy into the main page, but (obviously) don't execute it when the Module is invoked. Or,
  2. Assume that every module has a method called doc, and call it to generate the docs. This has the benefit of being in the same page, and of being somewhat more automatic (you could easily change a default value, for example, without having to update the docs).

Just a few thoughts, let me know whatcha think! --MarkTraceur (talk) 20:34, 22 August 2012 (UTC)Reply[reply]

This seems related to bugzilla:39609. --MZMcBride (talk) 05:00, 28 August 2012 (UTC)Reply[reply]