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";
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
is there a current archive of this list somewhere?
http://www.mail-archive.com/perl-documentation@perl.org/ does NOT show
anything past 2009.
--
Caleb Cushing
http://xenoterracide.blogspot.com
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
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
On Fri, Jul 2, 2010 at 09:46, Caleb Cushing wrote:
> is there a current archive of this list somewhere?
> http://www.mail-archive.com/perl-documentation@perl.org/ does NOT show
> anything past 2009.
snip
http://groups.google.com/group/perl.documentation/topics seems to be
working, but it isn't sh
If you want to sign up for the Perl 5 Documentation Team, leave an
email here or email me directly. If you know what you want to work on
mention it, otherwise I will assign you a task.
--
Chas. Owens
wonkden.net
The most important skill a programmer can have is the ability to read.
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
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
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
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
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
If you have a proposed logo and/or mascot for the Perl 5 Documentation
Team, post it here for discussion. A choice, but possibly not the
final choice, will be made by 2010-07-31. If no suitable logo and/or
mascot has been found, I will choose an incredibly boring Creative
Commons licensed bit of
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";
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
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:
>
>
I need to look through what is done today before I put up my version
of the guidelines, but if you are already familiar with the way Pod is
used in the existing documents, don't let me stand in the way of you
proposing some guidelines.
--
Chas. Owens
wonkden.net
The most important skill a program
Proposed activites of the Perl 5 Documentation Team
---
* read documentation to ensure it is friendly to new users
Members will choose one or more documents or one or more sections of
larger documents and read them for accuracy and clarity. Overlap
This is a list of the short term goals for the Perl 5 Documentation
Team, the tasks needed to make the goal a reality, and the deadlines
for those tasks.
Overall hard deadline: 1st quarter 2011
Administrative Tasks:
* Define the activities of the Perl 5 Doc Team (deadline 2
1 - Administriva
1.1 - I'm not subscribed - how do I subscribe?
Send mail to
1.2 - How do I unsubscribe?
Send mail to , and wait for a
response. Once you reply to the response, you'll be unsubscribed.
1.3 - Is there an archive on the web?
Yes, there is. It is located at:
http://www.nntp.per
* All documenting of documentation changes will happend in the current
delta under
=head1 Documentation
* New documents are listed under
=head2 New Documentation
and contain a brief sentence or two to describe their purpose. If no
new Documents exist in this release, then a sentence that reads
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
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
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
On Fri, Jul 02, 2010 at 07:03:00AM -0700, Chas. Owens wrote:
> If you want to sign up for the Perl 5 Documentation Team, leave an
> email here or email me directly. If you know what you want to work on
> mention it, otherwise I will assign you a task.
et...@so here. Count me in. No particular a
On Fri, Jul 2, 2010 at 12:05, Karen Etheridge wrote:
> On Fri, Jul 02, 2010 at 07:03:00AM -0700, Chas. Owens wrote:
>> If you want to sign up for the Perl 5 Documentation Team, leave an
>> email here or email me directly. If you know what you want to work on
>> mention it, otherwise I will assign
On Fri, Jul 2, 2010 at 5:17 PM, Chas. Owens wrote:
> I need to look through what is done today before I put up my version
> of the guidelines, but if you are already familiar with the way Pod is
> used in the existing documents, don't let me stand in the way of you
> proposing some guidelines.
>
>
On 10-07-02 10:58 AM, Chas. Owens wrote:
If you have a proposed logo and/or mascot for the Perl 5 Documentation
Team, post it here for discussion. A choice, but possibly not the
final choice, will be made by 2010-07-31. If no suitable logo and/or
mascot has been found, I will choose an incredib
On Fri, Jul 02, 2010 at 06:46:24PM +0200, Leon Timmermans wrote:
> My suggestion would be to make sure all new code examples are properly
> tested by unit tests, and incrementally try to make that true for old
> code examples. Examples with bugs in them are rather embarrassing.
I really like that
This is the current assignments list. If you do not like the
assignment you have been given or need help email me or the list. If
you do not wish to be called by the name I have listed, please contact
me and I will change it in the next release of this email.
Tasks that still need people:
* r
On Jul 2, 2010, at 12:46, Leon Timmermans wrote:
> On Fri, Jul 2, 2010 at 5:17 PM, Chas. Owens wrote:
>> I need to look through what is done today before I put up my version
>> of the guidelines, but if you are already familiar with the way Pod is
>> used in the existing documents, don't let m
On Fri, 02 Jul 2010, Karen Etheridge wrote:
> On Fri, Jul 02, 2010 at 06:46:24PM +0200, Leon Timmermans wrote:
> > My suggestion would be to make sure all new code examples are
> > properly tested by unit tests, and incrementally try to make that
> > true for old code examples. Examples with bugs i
On Fri, Jul 2, 2010 at 4:03 PM, Chas. Owens wrote:
> If you want to sign up for the Perl 5 Documentation Team, leave an
> email here or email me directly. If you know what you want to work on
> mention it, otherwise I will assign you a task.
>
> --
> Chas. Owens
> wonkden.net
> The most important
I'll throw my hat into the ring too. This is really the first time I've
done something like this so I'm excited to get my hands dirty. Don't really
have anything specific that I'd like to work on right now so sign me up for
whatever.
~Adam Lesperance~
On Fri, Jul 2, 2010 at 09:03, Chas. Owens
On Fri, Jul 2, 2010 at 1:44 PM, Chas. Owens wrote:
> I have been thinking about this as well. I need to do more research, but I
> was hoping we could drop the test code into the pod in =for sections.
Test::Synopsis (I think it is) and dzil .. ::SynopsisTests might
render clues on how to test c
On Fri, Jul 2, 2010 at 10:03 AM, Chas. Owens wrote:
> If you want to sign up for the Perl 5 Documentation Team, leave an
> email here or email me directly. If you know what you want to work on
> mention it, otherwise I will assign you a task.
>
me too (putting money where mouth is).
can't look
On Fri, Jul 02, 2010 at 11:19:02AM -0400, Chas. Owens wrote:
> Administrative Tasks:
>
Another one, which should have a reasonably short deadline, is identifying
the procedure for making documentation changes itself!
Presumably this would be using a git repository, so we need
On Fri, Jul 2, 2010 at 14:06, Leon Timmermans wrote:
> I'm in too.
snip
Choose something from the short term goals list for now.
snip
> * Changing all uses of typeglob filehandles to lexical filehandles
> (except where documenting open itself, obviously)
> * Changing all uses of two argument ope
On Fri, Jul 2, 2010 at 2:45 PM, Karen Etheridge wrote:
> The document at
> http://search.cpan.org/~doy/Moose-1.08/lib/Moose/Manual/Contributing.pod is
> an excellent template for describing the workflow of various
> participants and the use of various branches.
>
another option would be using t
On Fri, Jul 2, 2010 at 14:20, Adam wrote:
> I'll throw my hat into the ring too. This is really the first time I've
> done something like this so I'm excited to get my hands dirty. Don't really
> have anything specific that I'd like to work on right now so sign me up for
> whatever.
>
> ~Adam Le
On Fri, Jul 2, 2010 at 14:35, Caleb Cushing wrote:
> On Fri, Jul 2, 2010 at 10:03 AM, Chas. Owens wrote:
>> If you want to sign up for the Perl 5 Documentation Team, leave an
>> email here or email me directly. If you know what you want to work on
>> mention it, otherwise I will assign you a tas
On Fri, Jul 2, 2010 at 14:45, Karen Etheridge wrote:
> On Fri, Jul 02, 2010 at 11:19:02AM -0400, Chas. Owens wrote:
>> Administrative Tasks:
>>
>
> Another one, which should have a reasonably short deadline, is identifying
> the procedure for making documentation changes itsel
On Fri, Jul 02, 2010 at 11:19:02AM -0400, Chas. Owens wrote:
> * Create perlfuncref (deadline 2010-10-31)
I note that perlfuncref.pod would not be unique within the 8.3 naming
convention, so it may not be a suitable name for the document.
Ronald
On Fri, Jul 2, 2010 at 15:32, Ronald J Kimball wrote:
> On Fri, Jul 02, 2010 at 11:19:02AM -0400, Chas. Owens wrote:
>
>> * Create perlfuncref (deadline 2010-10-31)
>
> I note that perlfuncref.pod would not be unique within the 8.3 naming
> convention, so it may not be a suitable name for the doc
Greetings,
On Fri, Jul 2, 2010 at 7:54 PM, Chas. Owens wrote:
> On Fri, Jul 2, 2010 at 14:35, Caleb Cushing wrote:
>> On Fri, Jul 2, 2010 at 10:03 AM, Chas. Owens wrote:
>>> If you want to sign up for the Perl 5 Documentation Team, leave an
>>> email here or email me directly. If you know what
On Fri, Jul 2, 2010 at 16:16, Nuno 'smash' Carvalho
wrote:
> Greetings,
>
> On Fri, Jul 2, 2010 at 7:54 PM, Chas. Owens wrote:
>> On Fri, Jul 2, 2010 at 14:35, Caleb Cushing wrote:
>>> On Fri, Jul 2, 2010 at 10:03 AM, Chas. Owens wrote:
If you want to sign up for the Perl 5 Documentation T
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
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
48 matches
Mail list logo
