Jump to content

Topic on Extension talk:Scribunto

Suggestion: Document modules automatically (e.g. using LDoc, luadoc, etc)

2
197.218.80.152 (talkcontribs)

One of the pain points of lua is that aside from being hard for the average person, it is also a pain to document. There are no guidelines, and most users seem to focus on documenting how to use the modules rather than how they work.

Perhaps one of the existing libraries would be useful here:

This would enable automatic documentation like the module section of this page (generated using a lua script and explua), for example:

It is possible to do this in any wiki, but such hacks will always be inferior to built in solutions which could for example parse the docs of all dependent modules and show them in a user friendly way.

Anomie (talkcontribs)

This was considered and rejected during development. If the documentation is generated from the code of the module, then any updates to the documentation require that all pages using the module be reparsed. This is also one of the reasons templates typically have documentation transcluded from a subpage instead of having the documentation inline.

BTW, since you seem to change IP addresses daily if not more often, it would be easier to communicate with you if you were to create an account.

Reply to "Suggestion: Document modules automatically (e.g. using LDoc, luadoc, etc)"