develooper Front page | perl.perl5.porters | Postings from April 2010

Re: RFC: Perl manual pages -- update to follow the perlstyle.pod guidelines

Thread Previous
From:
Jari Aalto
Date:
April 2, 2010 10:31
Subject:
Re: RFC: Perl manual pages -- update to follow the perlstyle.pod guidelines
Message ID:
87iq897odo.fsf@jondo.cante.net
Ævar Arnfjörð Bjarmason <avarab@gmail.com> writes:

> On Fri, Apr 2, 2010 at 16:55, Jari Aalto <jari.aalto@cante.net> wrote:
>
>> I noticed that many of the manual pages are inconsistent with the
>> perlstyle.pod guidelines. While this may seem like a minor quibble, I
>> personally think the quality of documentation is visible from the
>> writing and adhering to the style conventions.
>
> I'd just like to say that it's very useful that someone is checking
> out this aspect of our documentation. All of the fixes you propose all
> look good. The examples in our documentation should reflect best
> practices, they don't right now.
>
>> I could send the patches for each pages in a separate threads?
>
> I don't know how Jesse would like to get them but if it was me I'd
> find it easier to merge it from a branch somewhere. Do you have a Git
> repository somewhere with these fixes?

The work I've done so far include branches:

    pod/perldebug.pod
    pod/perlebcdic.pod
    pod/perlembed.pod
    pod/perlfunc.pod
    pod/perlguts.pod
    pod/perlhack.pod
    pod/perlipc.pod
    pod/perlrepository.pod
    pod/perlretut.pod
    pod/perlrun.pod
    pod/perlstyle.pod
    pod/perlsyn.pod
    pod/perlxstut.pod

Note: None of these are complete yes as I go through checklists, like
those mentioned in my first mail.

The repository is clone of Perl 'blead' and is available at:

    git remote add jari git://github.com/jaalto/perl.git

Thanks,
Jari


Thread Previous


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