7 ms·
Yeah the CL community likes to be lone warriors, I am definitely very guilty of that. Documentation in CL is pretty bad. Worst is when people say its well docu
by math-dev 5y ago
Yeah the CL community likes to be lone warriors, I am definitely very guilty of that.
Documentation in CL is pretty bad. Worst is when people say its well documented and its nothing but, all those manuals just listing all the functions are a complete nightmare and useless to me
- throw10920 5y agoI'm guilty of this too! Change begins with one's self, they say, heh. (I should learn to write good docs before castigating the community) And you're right - trivial docstrings for all the functions isn't documentation at all. Real documentation is the four-part system[1] of tutorials, howtos, examples, and reference material - I've found this mental framework to be enormously helpful for both (a) identifying when some other documentation is inadequate and (b) improving my own. [1] https://documentation.divio.com/ https://documentation.divio.com/
- svetlyak40wt 5y agoThat is why I've put about half of this year into the Common Lisp documentation generator for all of my libraries. If you are interested, please read it's docs and join the effort of making good documentation for CL projects: https://40ants.com/doc/ https://40ants.com/doc/
- math-dev 5y agoThanks, will check it out!
- math-dev 5y agoAgree 100%