POD updates lib/A*~L*.pm #118
Conversation
|
Would you mind creating a page linked to http://misterhouse.wikispaces.com/Coding+Best+Practices that describes the "format" you used for all these updates? I'll just call that the "right" format for now and copy it anytime I add a new function. |
|
Have you run perldoc and podchecker on each of these files to make sure the output is as you intended? I saw some places where it looks like you had intended to use a new-line to format a section. I sure you know that a single new-line is eaten by the pod format programs. Where a single new-line is normally used you need to add a blank line. I know you know all this, I'm just wondering if you looked at each change through perldoc to make sure it worked out the way you intended. |
|
I would not mind however I do not have access to the wiki. I am a member Beyond that I though we were taking all the documentation into the source On Sun, Mar 17, 2013 at 1:05 PM, Michael Stovenour <[email protected]
|
|
I have run pocchecker as well as run the entire lib/ directory through I am aware that a single newline is dropped in the conversion. I have made -D On Sun, Mar 17, 2013 at 3:40 PM, Dustin Robinson [email protected] wrote:
|
|
Ok. I didn’t see anything major. I was trying to reverse engineer your format for a new Insteon function I’m writing and saw a few cases that made me wonder if you had proofread the output. No big deal. From: drobinson0919 [mailto:[email protected]] I have run pocchecker as well as run the entire lib/ directory through I am aware that a single newline is dropped in the conversion. I have made -D |
|
Where were the ones you saw? I am trying to be thorough but there are lots of lines and im bound to miss some. |
|
Is there something wrong with these updates or is there something I should be doing? |
|
I for one was waiting until we are about to release 3.0 to merge these. There is little logic in that decision; mostly just laziness. |
|
Sorry it took so long. Busy with other projects... |
|
Please don't be sorry. I was just wondering if I had done something
|
Updated POD with new formatting to support all docs on one page, nicer TOC, more consistent layout: (did not touch any Insteon items as i believe those are being worked on)
=head1 NAME
B<package_name>
changed to:
=head1 B<package_name
also all other =head1 changed to =head2
Corrected formatting on =items for better output
=item C - description
changed to:
=item C
description
=cut
Reviewed all docs for consistency