Re: [doc-patch] Another rdoc formatting error in array.c

On Mon, 12 Jul 2004, H.Yamamoto wrote:
>
> Johan Holmberg <[e-mail]> wrote:
> (2004/07/11 02:09)
>
> >I have discovered yet another formatting error that I missed the
> >previous time. See the patch below.
>
> I merged your patch to mine. Now looks more consistent. Would you check this?
>

In general I think the changes are in the right direction (but I'll
print out a newly generated version an look at it in detail, and
maybe supply further comments later).

As I understand your diff you have:

- used 'index' as parameter name systematically
  (instead of 'i' and 'int' ...)
- used "#" to denote method names instead of "." (as in Array#each)
- used "array" systematically for the receiver in the
  call-seq of a method (instead of "self" sometimes earlier)
- used "self" for the receiver in the text describing a method
- misc. other cleanups

But I still notice some remaining inconsistencies. For example:

- sometimes "arr" is used instead of "array"
- sometimes methods are written as "Array#at" and sometimes as
  "<code>Array#each</code>".

I don't know what is the right way for method references, but at a
glance I think the alternative with <code>...</code> looks better.

/Johan Holmberg