DEV Community

[Comment from a deleted post]
Collapse
 
attilavm profile image
Attila Molnar

If the documentation is simple I use markdown, if it is complex enough and contains a lot of math, then org-mode + LateX can be a good choice.

Unit, property tests and more serious type annotations (Elm) can be seen as documentation too.

There are some language specific features, like Python or Clojure let you write unit test in your docstrings.

Collapse
 
ghost profile image
Ghost • Edited

I have only tried this once for my Emacs config but learning to use org-mode + org-babel was revelatory. A good egg at an EmacsNYC Meetup walked me through the set up and how to work with use-package. It made me wonder how well documenting a larger non-elisp project could be.