For what it's worth, the docstrings are indeed hand-formatted, but that's pretty easy with vim or any decent editor. The size of the docstrings is a bit of a problem. At one point on Twitter Fogus suggested that Trammel could help off-load documentation elsewhere, but I never was motivated enough to pursue it.
Cheers, Dave On Wednesday, July 25, 2012, Laurent PETIT wrote: > > > 2012/7/25 Dimitrios Jim Piliouras <jimpil1...@gmail.com<javascript:_e({}, > 'cvml', 'jimpil1...@gmail.com');> > > > >> ooo thanks Tassilo...I knew that the docstring is stored as metadata but >> I did not know I could mutate it after the binding is set..this is very >> cool on its own! >> >> As far as IDEs go i will have a look around even though i was quite happy >> with my minimal setup...I also tend to use clooj when on the road which is >> steadily getting better...I gave ccw several chances as I was totally in >> love with eclipse in my java days, but even though I do like the editor and >> all the clever things it can do, I still cannot get my head round how to >> work efficiently on the eclipse repl...I specifically remember spawning a >> new repl every time i was loading a namespace which seemed very odd cos i >> had to close them all at the end... > > > Then by all means give ccw another try > > > emacs on the other hand seems more like a religion rather than an > editor!!! The thing is my timetable atm does not allow any deviations and > it would big deviation if i was to decide to learn emacs any time soon.... > > thank you both for your precious time and suggestions... cheers! > > Jim > > > On Wed, Jul 25, 2012 at 4:02 PM, Laurent PETIT <laurent.pe...@gmail.com>wrote: > > > > 2012/7/25 Dimitrios Jim Piliouras <jimpil1...@gmail.com> > > Hmmm I see...you're saying that this is all due to my minimalistic repl > enviroment (raw terminal embedded in gedit + leiningen2)...I know eclipse > does folding and stuff but what about when you want to hit <enter> to break > a line and then you want to align some other sentence underneath? will it > show on the raw terminal exactly as it shows on the eclipse text-editor? > I'm asking because in gedit the only way i can predict where things go is > whenever i have a continuous string (no line breaks)... > > > tbh, Counterclockwise does not yet have folding (tho it is a WIP in a > contributor's branch I haven't yet had the time to review - shame on me) > > > > > Jim > > > > > On Wed, Jul 25, 2012 at 12:17 PM, Laurent PETIT > <laurent.pe...@gmail.com>wrote: > > 2012/7/25 Dimitrios Jim Piliouras <jimpil1...@gmail.com> > > Hi all, > > I've just watched Dave Ray's mini demo of seesaw on infoQ and what amazed > me (apart from the actual library) was the gorgeous documentation that is > attached to all the functions. Dave has done an amazing job - even though > it is essentially a swing wrapper you can get a lot done without knowing > any swing at all!!! This is pretty good stuff...I was wondering if there is > an easier way to generate docstrings like that without alligning spaces and > tab manuallys and more importantly without inlining them with the > functions. I know it sounds a bit silly but if your source code is > dominated by docs then it is really hard to navigate up and down...I am > generally trying to keep my docs minimal with only plain english and rarely > more than 3-4 lines. However, after seeing what Dave has done I feel rather > jealous! Whenever I tried to produce docs like his the result is rather > ugly unless i systematically fiddle with it through trial and error...So in > essence 2 questions: > > -Is there a way write the docs in a separate place (different section of > the document or different document altogether)? > -Is there another way to style your documentation text other than manual > evolutionary means (trial and error)? > > > Third option : use an editor/IDE which allows you to "fold" docs (one by > one / fold all / unfold all), and / or to navigate in your source code via > "code outlines" > > > > Just in case Dave is lurking around, > -You actually wrote and styled all that documentation by hand? > > > Jim > > -- > 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 > > > -- > 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<javascript:_e({}, 'cvml', > '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 <javascript:_e({}, 'cvml', > 'clojure%2bunsubscr...@googlegroups.com');> > For more options, visit this group at > http://groups.google.com/group/clojure?hl=en -- 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