7 ms·
Great story. Unfortunately, the API documentation and tutorial writing guilds went extinct decades ago and has never been able to return to Lispland. :)
by bjourne 14y ago
Great story. Unfortunately, the API documentation and tutorial writing guilds went extinct decades ago and has never been able to return to Lispland. :)
- stcredzero 14y agoSeriously, this is a great point. One of the big problems with a small community of programmers who all think of themselves as elite, is that tasks like documentation and tutorial writing go by the wayside. This comment should be a wake-up call to any smart and far-sighted individuals who want to promote a language.
- pnathan 14y agoIs there a open source Common Lisp library that you'd like to see better documented? Also, if you're (or anyone else is) interested in working on a Common Lisp environment tutorial, shoot me an email. I've been working on one but haven't launched it yet.
- stcredzero 14y ago> Is there a open source Common Lisp library that you'd like to see better documented? I was talking as a long time member of a different programming community with similar attributes. (Smalltalk - since 1998)
- ludston 14y agoI would love to see cffi, opengl and one of the gtk binding libs have better documentation.
- orthecreedence 14y agoThe opengl bindings don't really need documentation, as they're automatically generated to mirror the C API. Really, if you want to know how to use `cl-opengl`, you memorize a simple naming convention and the rest is a matter of "how do I use OpenGL," not "how do I use cl-opengl?"
- ludston 14y agoThat's great, but I haven't learned C. Besides that, leveraging documentation from another language is a hack. As it stands, there isn't documentation around for learning to create 3d graphics without needing to know other languages first.
- pavelludiq 14y agoAre you trolling? First off, learning C well enough to understand opengl documentation will take you much less time that understanding opengl it self(since you'll only need to read and not write C). You have a problem, people gave you a solution, having separate cl docs for opengl that have THE SAME contents, but using lisp function names instead of C ones(as it was explained, it is simple function to transform one into the other in your head). What the hell do you want? PS I forgot why I stopped commenting on HN threads about lisp. If you read the old usenet, this kind of discussion has been plaguing lisp since day one. People complain, and when given the solution, they just start bitching about something else, avoiding the solution. There are no docs, now the docs are in C, what else? As I've become part of the lisp community, I learned the proper way to fix this, If I encounter deficiency in the lisp ecosystem, I deal with it if I can, and If I can't I politely ask the author/maintainer if they have time to work on the issue. If they don't have the time, I simply accept reality, and move on with my problems. Bitching on HN solves nothing. Honestly, why lisp? Why do people have this supreme need to express their dissatisfaction with a language, with libraries developed by humans in their spare time away from their lives, for free. Be fucking happy, and help out if you care about lisp, otherwise, just shut up!
- ludston 14y agoWhy are you angry? It look like you've decided that if people complain about something, those people must be broken and not the system. And why do people complain about Lisp? It's because the syntax is amazing. It's an incredible language to write in. It is more expressive than anything anyone has ever used, but then they can't do anything with that because it takes so much more effort with lisp to do things that are taken for granted in other languages. GUI libraries and frameworks are so easy with C based languages, because they contain powerful tools that I don't have to write myself.
- pnathan 14y agoI don't know CFFI well enough to take a stab at it. The github manual has a lot of words in it, afaict. :-) However, I've been longing for getting one of the GTK bindings working for me; when I do that I'll contribute back some docs.
- Guthur 14y ago...And cffi is one of the better documented libraries, I have used it quite a bit and have had very little trouble working it out.
- calinet6 14y agoYep. They have time to draw elaborate cartoons, but not elaborate documentation! Funny how that works.
- brianmwaters 14y agoActually, that cartoon is part of an elaborate book (landoflisp.com) meant to school beginners on Lisp.
- octopus 14y agoThe author (Conrad Barski) wrote a book: Land of Lisp ...
- chiquitabacana 14y ago...that's...not really...an...elaborate...cartoon... It's kind of...clumsy...and grotesque....
- deleted 14y ago[deleted]
- eggsby 14y agoThe comic references clojure in multiple sections (multicore, lazy), I think you'll find the tutorial and documentation guilds still alive and well there.
- bjourne 14y agoActually my snide remark came from trying to find docs for Clojure libraries. :) Clojure Docs (http://clojuredocs.org/ http://clojuredocs.org/) is alright for the standard library, API documentation (http://clojure.github.com/clojure/ http://clojure.github.com/clojure/) not so nice. But finding complete and updated docs for Compojure or any other of Clojure's web frameworks is impossible. Ironically, Noir (http://www.webnoir.org/ http://www.webnoir.org/) seem to be the best documented of the bunch but it has been deprecated.
- eschulte 14y agoThis is how false misperceptions are spread. I'd ask you to mention a lisp library which you use but find under-documented (as another reply already has), but I don't think anyone with actual first-hand knowledge of the CL ecosystem would make this comment (even though I'm sure it recieved many enthusiastic if uninformed upvotes). Lets look at some popular libraries with documentation. - Alexandria http://common-lisp.net/project/alexandria/draft/alexandria.html http://common-lisp.net/project/alexandria/draft/alexandria.h... - CL-PPCRE http://weitz.de/cl-ppcre/ http://weitz.de/cl-ppcre/ - metabang-bind http://common-lisp.net/project/metabang-bind/ http://common-lisp.net/project/metabang-bind/ - not to mention the standard by which all other language documentation should be judged, the CL hyperspec http://www.lispworks.com/documentation/HyperSpec/Front/ http://www.lispworks.com/documentation/HyperSpec/Front/ And with sites like http://www.cliki.net/ http://www.cliki.net/, http://common-lisp.net/ http://common-lisp.net/ and http://www.gigamonkeys.com/book/ http://www.gigamonkeys.com/book/ and many other full length books, if you can't find lisp documentation you're not looking very hard.
- betterunix 14y ago"I don't think anyone with actual first-hand knowledge of the CL ecosystem would make this comment" I'll make that statement, but only in a somewhat pedantic sense about the language standard itself. Yes, I know CLTL2 is over a thousand pages long, but the one thing about programming languages that always bothers me is undefined behavior. Sadly, even Common Lisp has undefined behavior; Paul Graham's book On Lisp actually relies on undefined behavior being implemented in a particular way e.g. using setq on an unbound variable. Good documentation should not leave anything undefined; good documentation should leave no questions about the semantics of a system/API/language. Given source code and documentation, it should be possible (perhaps difficult, but possible) for a person to figure out what will happen if the program is run.
- lispm 14y agoThe undefined behavior in the Common Lisp specification was a design choice. It has nothing to do with 'good' or 'bad' documentation. Common Lisp was designed from 1981 on. The Lisp community (here the successors of Maclisp) went to explore a lot of new ground: implementations on mini computers, mainframes, super computers, parallel machines, microprocessors, stack architectures, on top of other programming languages like C, etc. There were small and stupid compilers, optimizing compilers, whole-program compilers, ... It was a time of experimentation. At that time a lot of behavior was not defined to allow compiler writes to explorer different types of implementations. With the knowledge of a decade later some of that could have been defined more precisely, but then the standardization process ran out of steam due to lack of funding and interest. Using SETQ on an undefined variable may be undefined in the Common Lisp standard, but every implementation deals with that and allows it. That's a non-issue. There are a lot of other things which isn't defined in the standard and which all implementations deal with. Garbage Collection. Also not in the standard, but every user expects garbge to be collected. It would be nice to have less undefined behavior, but it has nothing to do with good or bad. It was useful in a time of experimenting. Even worse for Common Lisp was that in 1981 there wasn't yet an OOP system for Lisp that was explored and accepted. This way CLtL1 was defined without an object system and it had later to be added (CLOS).
- gcr 14y agoThey're alive and well for Racket and Clojure. Here's a racket guide, which provides detailed documentation for every facet of the language: http://docs.racket-lang.org/ http://docs.racket-lang.org/
- ripter 14y agoThis is why after trying to learn LISP I ended up with Racket.