Jump to content

Community Wishlist/Wishes/Document ALL the modules!

From Meta, a Wikimedia project coordination wiki
Document ALL the modules! Open

Edit wish Discuss this wish

Description

Most modules have very little or even zero documentation, despite being heavily used. This is really bad! On Wikimedia, as with anywhere else, large amounts of undocumented, production-critical code is terrifying!

Some examples of the most heavily used modules:

There are three major hiccups when it comes to documenting modules. First, usually a module is used in one or more wrapper templates or metatemplates. The templates are then documented rather extensively, but the modules are relatively forgotten. Secondly, the TemplateData extension allows you to document templates, but not modules. Thirdly, MediaWiki modules have to be written in Lua, and very very few people can read or write code in Lua fluently (and I am not one of them). Lua is a pretty rare programming language, as compared to more popular ones like Python or JavaScript.

A feature that would allow users to document all the modules - plus a Wikimedia-wide push to actually write all the documentation pages - would be extremely helpful.

Assigned focus area

Unassigned.

Type of wish

Feature request

All projects

Affected users

All module and template editors

Other details

  • Created: 05:25, 26 August 2024 (UTC)
  • Last updated: 15:17, 3 September 2024 (UTC)
  • Author: Duckmather (talk)