Re: Announcing the Perl 5 Documentation Team

2010-07-09 Thread Abigail
On Fri, Jul 02, 2010 at 04:33:03PM -0500, brian d foy wrote: > > * Ignore any Perl released more than 10 years ago. So, ignore 5.6.0? Abigail

Re: Announcing the Perl 5 Documentation Team

2010-07-02 Thread Chas. Owens
On Fri, Jul 2, 2010 at 17:33, brian d foy wrote: > In article > , Chas. > Owens wrote: > >> No, you understood me, it is just that the FAQ doesn't do a good job >> for those two questions.  That is something we need to be doing >> better. > > The FAQ doesn't do a good job of teaching you Perl bec

Re: Announcing the Perl 5 Documentation Team

2010-07-02 Thread brian d foy
In article , Chas. Owens wrote: > No, you understood me, it is just that the FAQ doesn't do a good job > for those two questions. That is something we need to be doing > better. The FAQ doesn't do a good job of teaching you Perl because it's not the FAQs job to teach you Perl. The FAQ is not th

Re: Announcing the Perl 5 Documentation Team

2010-07-02 Thread Chas. Owens
On Fri, Jul 2, 2010 at 11:46, Gabor Szabo wrote: snip > Chas,  I am not sure: > > $ perldoc -q trim > No documentation for perl FAQ keyword `trim' found > > # perldoc -q open > gives a lot of FAQs but none of them gives the simple case > of > >   open my $fh, '<', $filename or die $!; >   while (m

Re: Announcing the Perl 5 Documentation Team

2010-07-02 Thread Gabor Szabo
On Fri, Jul 2, 2010 at 6:08 PM, Gabor Szabo wrote: > On Fri, Jul 2, 2010 at 5:55 PM, Caleb Cushing wrote: >> On Fri, Jul 2, 2010 at 10:33 AM, Gabor Szabo wrote: >>> Interestingly I would have said that the documentation is mostly needed >>> by novices or by people who rarely use Perl. The differ

Re: Announcing the Perl 5 Documentation Team

2010-07-02 Thread Shawn H Corey
On 10-07-02 10:33 AM, Gabor Szabo wrote: I don't know much about experts but I think we should make it easy for people with no, or little background in Perl to get simple answers to their questions with pointers to further details. I think the vast majority of people using Perl are in this catego

Re: Announcing the Perl 5 Documentation Team

2010-07-02 Thread Chas. Owens
On Fri, Jul 2, 2010 at 11:02, David Golden wrote: > On Fri, Jul 2, 2010 at 9:30 AM, Chas. Owens wrote: >> Lets take a quick look at what it would really look like.  I chose >> substr at random and updated it to fit scenario 3.  It took four > > At the risk of cherry picking my examples, try: > >

Re: Announcing the Perl 5 Documentation Team

2010-07-02 Thread Gabor Szabo
On Fri, Jul 2, 2010 at 5:55 PM, Caleb Cushing wrote: > On Fri, Jul 2, 2010 at 10:33 AM, Gabor Szabo wrote: >> Interestingly I would have said that the documentation is mostly needed >> by novices or by people who rarely use Perl. The difference might be >> because I encounter so many people who a

Re: Announcing the Perl 5 Documentation Team

2010-07-02 Thread Chas. Owens
On Fri, Jul 2, 2010 at 10:58, Caleb Cushing wrote: > On Thu, Jul 1, 2010 at 7:11 PM, Chas. Owens wrote: >> Failure to add a use 5.010; or use 5.012; limits the features that can >> be used in examples.  For instance, this example won't work even under >> 5.12 as it is written: >> >>    say "foo";

Re: Announcing the Perl 5 Documentation Team

2010-07-02 Thread Caleb Cushing
On Thu, Jul 1, 2010 at 7:11 PM, Chas. Owens wrote: > Failure to add a use 5.010; or use 5.012; limits the features that can > be used in examples.  For instance, this example won't work even under > 5.12 as it is written: > >    say "foo"; > > It is possible that we should only add use statements

Re: Announcing the Perl 5 Documentation Team

2010-07-02 Thread Chas. Owens
On Fri, Jul 2, 2010 at 10:33, Gabor Szabo wrote: > On Fri, Jul 2, 2010 at 3:57 PM, David Golden wrote: >> On Fri, Jul 2, 2010 at 8:22 AM, Chas. Owens wrote: >>> It isn't just that say wasn't added until 5.10, it is that say doesn't >>> even work without a "use 5.010;" or similar statement.  This

Re: Announcing the Perl 5 Documentation Team

2010-07-02 Thread Caleb Cushing
On Fri, Jul 2, 2010 at 10:33 AM, Gabor Szabo wrote: > Interestingly I would have said that the documentation is mostly needed > by novices or by people who rarely use Perl. The difference might be > because I encounter so many people who are learning Perl. depends on /what/ documentation you're

Re: Announcing the Perl 5 Documentation Team

2010-07-02 Thread Gabor Szabo
On Fri, Jul 2, 2010 at 3:57 PM, David Golden wrote: > On Fri, Jul 2, 2010 at 8:22 AM, Chas. Owens wrote: >> It isn't just that say wasn't added until 5.10, it is that say doesn't >> even work without a "use 5.010;" or similar statement.  This means >> that the person coming to the Perl for the fi

Re: Announcing the Perl 5 Documentation Team

2010-07-02 Thread Ævar Arnfjörð Bjarmason
On Fri, Jul 2, 2010 at 13:56, Horsley, Tom wrote: > Good luck with this. I'll just mention one thing that has bothered me since > the documentation got all improved when moving from perl4 to perl5: > > The perl4 doc was all one giant man page, which made it really simple > to search. It would be n

Re: Announcing the Perl 5 Documentation Team

2010-07-02 Thread Chas. Owens
On Fri, Jul 2, 2010 at 09:50, Shawn H Corey wrote: > On 10-07-02 09:30 AM, Chas. Owens wrote: >> >> Proposed style: >> >> =item substr EXPR,OFFSET snip > What the heck is LENGTH? snip My copy and paste left out =item substr EXPR,OFFSET,LENGTH,REPLACEMENT X X X X X =item substr EXPR,OFFSET,LENGT

Re: Announcing the Perl 5 Documentation Team

2010-07-02 Thread Shawn H Corey
On 10-07-02 09:30 AM, Chas. Owens wrote: Proposed style: =item substr EXPR,OFFSET Extracts a substring out of EXPR and returns it. First character is at offset C<0>, or whatever you've set C<$[> to (but don't do that). If OFFSET is negative (or more precisely, less than C<$[>), starts that fa

Re: Announcing the Perl 5 Documentation Team

2010-07-02 Thread Chas. Owens
On Fri, Jul 2, 2010 at 08:57, David Golden wrote: > On Fri, Jul 2, 2010 at 8:22 AM, Chas. Owens wrote: >> It isn't just that say wasn't added until 5.10, it is that say doesn't >> even work without a "use 5.010;" or similar statement.  This means >> that the person coming to the Perl for the firs

Re: Announcing the Perl 5 Documentation Team

2010-07-02 Thread Chas. Owens
On Fri, Jul 2, 2010 at 07:18, David Golden wrote: > On Thu, Jul 1, 2010 at 7:11 PM, Chas. Owens wrote: >> Failure to add a use 5.010; or use 5.012; limits the features that can >> be used in examples.  For instance, this example won't work even under >> 5.12 as it is written: >> >>    say "foo";

Re: Announcing the Perl 5 Documentation Team

2010-07-01 Thread Chas. Owens
On Thu, Jul 1, 2010 at 17:29, Ævar Arnfjörð Bjarmason wrote: snip >>  * Extensive review and Modernization of all examples > > One thing I'd like to suggest. I think it'd improve our code examples > a lot if we used a consistent style for them. By that I mostly mean > not coding style (we've had t

Re: Announcing the Perl 5 Documentation Team

2010-07-01 Thread Chas. Owens
On Thu, Jul 1, 2010 at 16:40, Paul Johnson wrote: snip >>   * Updating the documentation so that all examples longer than one >>       line contain a `use` statement indicating the minimum version of >>       Perl 5 required to run the example > > I'm afraid that I don't think this is a sensible s

Re: Announcing the Perl 5 Documentation Team

2010-07-01 Thread Ævar Arnfjörð Bjarmason
On Thu, Jul 1, 2010 at 17:18, Chas. Owens wrote: > I am excited to announce the formation of the Perl 5 Documentation > Team.  Our goal is to have the best, most current, and easiest to use > and understand documentation of any programming language.  Why settle > for small goals? It's great that