Hi,

In message "Documentation for thread.rb"
    on 03/01/17, Gavin Sinclair <gsinclair / soyabean.com.au> writes:

|Below is a patch for thread.rb [1], containing RDoc comments.  These
|comments are taken directly from Pickaxe.  Here are the rules I
|followed when commenting (I made them up):
|
|  I'm using +word+ to put things in fixed-width font when:
|   - "word" appear in such font in Pickaxe
|   - "word" is a parameter to a method (note that these typically
|     appear in [...] in ri)
|
|  I include page references, because they are currently in ri.

This should eventually removed.

|  If a method is not documented in Pickaxe, I mark that in the code
|  with a FIXME.
|
|  I don't include class examples from the Pickaxe, but should I?

Perhaps.

|If people on this list have established some rules about commenting
|the standard libraries, please let me know what they are, as I intend
|to document several more files. Please comment on the rules above and
|the code below.
|
|Note especially that Queue and SizedQueue are not documented in
|Pickaxe (online version).  At least I can't find them.  I've therefore
|made a comment in the code asking if "Ruby in a Nutshell" should be
|used as a source instead.

Please.  You can use the Nutshell

|[1] I'm inexperienced in creating patches - I just used cvs diff -u.
|I don't expect this to be treated as a patch just yet anyway.

This is excellent.  And you can commit them.  Now you are the
committer, aren't you?

							matz.