Phil Hagelberg <p...@hagelb.org> writes: > On Tue, Sep 7, 2010 at 1:25 AM, Mark Engelberg <mark.engelb...@gmail.com> > wrote: [...] >> Javadoc has an interesting property: it considers that the first >> sentence serves as a summary for the doc. The "sentence" delimiter is >> just the point in the case of javadoc. > > Emacs docstrings work this way too; the first line must stand alone > and provide a summary. I think this would be a great convention to > adapt for Clojure, but that cat may already be out of the bag. >
+1 for complete sentences on the first line of a doc-string (whether period or newline delimited). Another elisp convention which I find very useful is using `' to quote function names e.g. `map'. Documentation browsers can then link these names to the documentation of the quoted function. This is especially useful in a functional languages where function composition is the norm. Clojure is certainly young enough for new conventions to emerge, especially with some buttressing from documentation tools. Best -- Eric -- You received this message because you are subscribed to the Google Groups "Clojure" group. To post to this group, send email to clojure@googlegroups.com Note that posts from new members are moderated - please be patient with your first post. To unsubscribe from this group, send email to clojure+unsubscr...@googlegroups.com For more options, visit this group at http://groups.google.com/group/clojure?hl=en
