On Mon, Aug 04, 2003 at 11:28:18PM +1000, Gavin Sinclair wrote:
>
> It's hard for me to come to a conclusion. I sort of angle towards the
> file level as well, with a clear comment on the main class (perhaps
> most/all classes?) that says "For usage information see ...".
OK, I'll stick to this convention for the time being.
> One good reason for class level, though, is that the usage
> information will then come out in ri/rj.
I'm only passingly familiar with ri. Couldn't/shouldn't it
also produce documentation for files? So that someone
reading code and seeing "require 'tld/yama'" could say "ri
tld/yama" to find out what this file provides?
> FYI, William, shortly before you joined the list we were working on
> "rj" ("ri".succ), which is a modified ri to support the standard
> library (you do know ri, right? :) I submitted some code, James
> submitted a bug report, then I got busy with life, work, and
> http://vim-ruby.rubyforge.net.
I'm a vim user, so I appreciate your work on this very much.
BTW, I notice on http://vim-ruby.rubyforge.org/ that the
link to rubygarden doesn't work (missing http:// at the
start, so is taken as relative).
William
|
