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

Doing Something For Better Documentation

Thread Next
From:
Casey West
Date:
April 21, 2003 08:16
Subject:
Doing Something For Better Documentation
Message ID:
20030421152048.GJ87115@geeknest.com
Rather than fishing for solutions, I'm willing to take the ball and do
something useful for documentation.  See patch below.

I'll take this to the perl-documentation@perl.org mailing list and
start an editorial overhaul.  There are a set of goals, I'll give an
overview here.

  - Correct spelling and grammar.
  - Consistency with term usage.
  - Up to date examples conforming to popular coding practices.
  - More internals documentation.
  - Expansion.
  - Organization.
  - etc, etc.

Anyone can contribute.  It's easy, send a sane patch.  There are many
areas where you can contribute (as an example, I don't know too much
about VMS).  I'll send a more detailed message later today to
perl-documentation@perl.org outlining the steps we need to take
first.

diff -ru perl-current.orig/pod/perlhack.pod
perl-current/pod/perlhack.pod
--- perl-current.orig/pod/perlhack.pod  Mon Apr 21 10:50:06 2003
+++ perl-current/pod/perlhack.pod       Mon Apr 21 10:51:24 2003
@@ -43,7 +43,7 @@
 
 In addition, various people are pumpkings for different things.  For
 instance, Andy Dougherty and Jarkko Hietaniemi share the I<Configure>
-pumpkin.
+pumpkin, and Casey West is the I<documentation> pumpking.
 
 Larry sees Perl development along the lines of the US government:
 there's the Legislature (the porters), the Executive branch (the


  Casey West

-- 
Shooting yourself in the foot with Prolog 
You tell your program you want to be shot in the foot. The program
figures out how to do it, but the syntax doesn't allow it to explain. 


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