Re: Keeping perlfaq.pod up to date

[email protected] (_brian_d_foy)
Newsgroups perl.documentation,perl.cvs.perlfaq
Message-ID <310120020319430082%[email protected]>
In article <[email protected]>, Chris Fedde <[email protected]> wrote:

> On Wed, 30 Jan 2002 22:49:28 -0600  _brian_d_foy wrote:

>  | furthermore, since many of the differences i fixed were matters of
>  | style, should we have a style guide for the documentation?  

> We can make the style be "whatever passes _bryan_d_foy's script".
                                               ^
                                               |
and people wonder why i have a style guide :) -+

> Do you think that is fair?

well, my script just builds perlfaq.pod.  it doesn't check anything for
style, and i'm not about to write such a beast :)

in style, i mean things like:

   * consistent use of punctuation (e.g. are we using a series comma or not?)
   * agreed upon use of certain words (e.g. regexps or regexes?)
   * some sort of notion of voice, person, and tense (e.g. active voice, 
   first person, present) unless something else is appropriate (e.g. things 
   in the past don't use the present tense ;)

and so on.  i don't pretend that a right answer exists, but whatever we choose,
IMO, should be used consistently.  we've been hacking at this on a per question
basis lately and it's starting to show. :)
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.