Re: Array and Enum: Elements or Objects?
Hugh Sasse <[email protected]> Fri, 13 May 2011 16:45:22 +0100 (BST)
| Newsgroups | gmane.comp.lang.ruby.documentation |
|---|---|
| Message-ID | <[email protected]> |
Before you put this work in, I'd be inclined to ask: why is this a problem?
Are you seeing some possible form of confusion? Just reading this paragraph
and not refreshing my memory of the docs, I'd tend to only distinguish between
elements and objects for things like Array#uniq where non-nil elements are
objects. Otherwise, a variety of word use tends to make English flow better.
Why does English have another word for "walrus"? Searching for
synonyms improve writing
produces a lot of relevant results. Repetitive word choice seems to be
widely considered a fault. That's anecdotal, but is supported in a limited
way by searching for this kind of critique. In Ruby most elements are going
to be objects, and even nil is an object.
HTH
Hugh
On Fri, 13 May 2011, Loren Sands-Ramshaw wrote:
> The documentation in array.c and enum.c uses the terms elements and objects
> inconsistently. Currently there are 100 elements and 18 objects in array.c
> and 59 elements and 21 objects in enum.c. I think element is the most
> widely-used term for things in an array. For enum I can see the argument for
> object given the range of things that can be enumerable, but wikipedia uses
> element to refer to the things that are being enumerated. Should I make
> everything in array.c element and everything in enum.c object, or just
> everything element? Or something else?
>
> Thanks,
> Loren
>