develooper Front page | perl.perl5.porters | Postings from May 2011

Re: [perl #90632] [PATCH] Docs: perlfunc: Rewrite `split'

Thread Previous | Thread Next
From:
Brad Baxter
Date:
May 16, 2011 07:14
Subject:
Re: [perl #90632] [PATCH] Docs: perlfunc: Rewrite `split'
Message ID:
BANLkTikp7tNY4FuM+uAGyYWSFHK=qwD_=w@mail.gmail.com
On Sun, May 15, 2011 at 3:09 PM, Michael Witten
<perlbug-followup@perl.org> wrote:
> # New Ticket Created by  Michael Witten
> # Please include the string:  [perl #90632]
> # in the subject line of all future correspondence about this issue.
> # <URL: http://rt.perl.org/rt3/Ticket/Display.html?id=90632 >
>
>
> Subject: [PATCH] Docs: perlfunc: Rewrite `split'
> Date: Sun, 10 Apr 2011 23:23:21 +0000
> From: Michael Witten <mfwitten@gmail.com>
>
> I couldn't stand the way the documenation for `split' was written;
> it felt like a kludge of broken English dumped into a messy pile by
> several people, each of whom was unaware of the other's work.
>

On a quick read, I'd like to make one suggestion.  You have
a lot of clauses combined with a semicolon.  I think that in
every case, a new sentence would be better.

A period let's me take a mental breath.  With a semicolon, I
have to keep holding that breath, because you're telling me
that the sentence isn't finished yet.  In my opinion, those long
sentences would work fine split into two.  :-)

-- 
Brad

Thread Previous | Thread Next


nntp.perl.org: Perl Programming lists via nntp and http.
Comments to Ask Bjørn Hansen at ask@perl.org | Group listing | About