On 2010 Apr 21, at 5:04 PM, Tom Faulhaber wrote:
(For those who don't know, I'm the one who maintains the autodoc API
documentation.)
Cool, thank you!
One resource to use is the index included with each API. (See the
index link in the left sidebar.)
I saw that, but you know, after finding out that "Branches" and
"Overview" and "Namespaces" don't do anything, I had just assumed that
"API Index" didn't do anything either; based on clicking those headers
when first landing on the contrib page. Sigh.
This has every function, macro and
var in the whole library with a snippet of their doc. I find this to
be pretty useful sometimes, especially when I don't remember which
namespace something's in. I've always wished the Python doc had this
feature!
Python does come close: http://docs.python.org/genindex-all.html
(It takes a few clicks from the main docs page: library -> index ->
full-index-on-one-page.
It does show you the library location, but not any part of the
individual documentation.)
(I'm used to using the Python 2.4 docs since my day job situation uses
that older version:
http://docs.python.org/release/2.4.4/lib/genindex.html)
A couple things I've also been thinking about are building in a search
capability and building a "super-index" of not only core and contrib
but various other external libraries that would link back to their
doc.
Having one index that spans the core and the contrib library would be
a huge step forward.
Adding in other stuff would be cool, but I would hope that would not
delay work unifying core/contrib.
Please also understand that Clojure is a young language and things are
still very much under development.
Yup.
We're still understanding what our
"best practice" is and how to approach it. As you point out,
clojure.contrib.io is an example where we're not there yet, but it is
happening. clojure.contrib.io is a precursor for a clojure.io
namespace that will unify these things.
Looking at the clojure.org front page, there is no "roadmap" link, or
anything that seems to be like that, to know what is on the radar,
etc. The "news" link points to: http://clojure.blogspot.com/ but that
seems to be a few months old. Clicking through the 'dev' link and
bouncing around, I eventually found:
http://www.assembla.com/spaces/clojure/milestones/149827-release-1-2
and it seems that there are only a handful of issues to be resolved
before 1.2 is cut?
Poking around a bit more, I found bug 282 having to do with fixing the
already changed duck-streams to io in test comments. Maybe I missed
some other link(s) that would show a higher level view of what is
planned?
Thanks for the ideas! Keep 'em coming.
Thank you for listening.
-Doug
--
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
