search

DFHack / dfhack

Memory hacking library for Dwarf Fortress and a set of tools that use it
Other
1.87k stars 475 forks source link

lua utilities file is not in lua api documentation #918

Open warmist opened 8 years ago

warmist commented 8 years ago

Some more useful functions are rewritten many times because i think of lack of utils file documentation.

PeridexisErrant commented 8 years ago

Hmm, ideally we'd have an automatic(ish) thing for this, where in-source comments are used to generate the documentation. (small research binge) Looks like the only viable options are luadoc (deprecated), or LDoc (successor project). Generated markdown from the latter should work with our Sphinx-doc system, though it would be nice to make it generate proper .rst files.

Probably best to write docs in the existing style ASAP, and someone can convert them over once there's a working system.