search

Raynes / fs

File system utilities for Clojure.
453 stars 119 forks source link

There should be a link to online document #35

Closed myguidingstar-zz closed 11 years ago

Raynes commented 11 years ago

What online document?

myguidingstar-zz commented 11 years ago

The one generated by autodoc. There should be a choice other than looking at source code.

Raynes commented 11 years ago

Ah, gotcha! Yeah, I should put up some generated documentation. Thanks for pointing this out!

philc commented 11 years ago

+1. There's no way to see what this library does or what it offers without looking at the source, which isn't a great experience. Even just listing a few of the key functions in the readme would help.

Raynes commented 11 years ago

Actually, looking at the source is nearly the same experience. If you compare documentation generated with something like codox, it's basically the same as the source without the bodies of the functions. ;)

philc commented 11 years ago

Sounds good, but let's at least state in the readme "to see the available functionality, view the [source]" where [source] is a like to the relevant file. My first instinct was to grep the readme and then google for docs rather than digging through the project's directory structure.

Raynes commented 11 years ago

I'm still gonna throw up some codox documentation. I was just being a smartass.

Raynes commented 11 years ago

http://raynes.github.com/fs/

philc commented 11 years ago

Awesome! Thanks