Re: [PATCH] PStore Documentation

----- Original Message ----- 
From: "James Edward Gray II"


> On Oct 26, 2005, at 4:41 PM, Eric Hodel wrote:
>
> >> A couple corrections & suggestions:
> >>
> >> "wiki[:wiki_index]         ||= Array.new"
> >> - Remove the extra whitespace
> >>
> >
> > Or just "wiki[:wiki_index] ||= []"
>
> I prefer the more explicit version, for empty arrays.  Everybody has
> their little style quirks.  ;)
>


Undeniably, but this example might distract the reader:

  home_page = WikiPage.new( String.new("DazButcher"),
                            String.new("The wiki home of Daz Butcher") )

more than this one:

  home_page = WikiPage.new( "HomePage",
                            "Welcome to ..." )

because the first one quirkily uses String.new ;)


I know, that's unfair, unkind, caustic and no way to show
appreciation etc., etc., but there's a point I wanted to
make which isn't directed at one person;  i.e. - IMHO,
the first example would jar most readers' concentration.
(Who or what is DazB.. and what is its significance here?)

   YMMV

I believe that Matz and contributors have given their
source code, generously, to everyone.
I hope that credit for documentation is acceptable to
the author(s) in the source file headers.  I find it
informative, unintrusive and highly justified.

Apologies in advance for any apparent, or evident, condescension.

Just thoughts from a grateful reader.

daz