4 ms·
Treating docs like specifications may seem onerous because of the specs that come to mind: entire languages, or the CSS/HTML specs. Massive documents, way too m
by mr_luc 14y ago
Treating docs like specifications may seem onerous because of the specs that come to mind: entire languages, or the CSS/HTML specs. Massive documents, way too much work.
But I fell in love with the CL HyperSpec years ago. Pick any section, (http://www.lispworks.com/documentation/HyperSpec/Front/ http://www.lispworks.com/documentation/HyperSpec/Front/) ... and it's amazingly clear, with sample code and everything.
And, yeah, it's a big spec. But CL is a big language, and not just any language, but a batteries-mostly-included language, fully specified.
In contrast, the programmer-facing API for most libraries is going to be fairly small. HyperSpec-quality docs probably wouldn't be that hard for most small-to-midsized projects.