develooper Front page | perl.perl5.porters | Postings from September 2018

[perl #133509] IPC::Open2 and IPC::Open3 documentation updates

Thread Previous
From:
Dan Book
Date:
September 10, 2018 22:13
Subject:
[perl #133509] IPC::Open2 and IPC::Open3 documentation updates
Message ID:
rt-4.0.24-14202-1536617605-983.133509-75-0@perl.org
# New Ticket Created by  Dan Book 
# Please include the string:  [perl #133509]
# in the subject line of all future correspondence about this issue. 
# <URL: https://rt.perl.org/Ticket/Display.html?id=133509 >


[Perl] IPC::Open2 and IPC::Open3 docs contain some out of date practices
and confusing terminology, which makes them more difficult for newcomers to
make use of. Attached will be a patch to update it in several ways:

* Remove direct usage of bareword filehandles and use lexical filehandles
for the first example in each synopsis.
* Add examples using STDIN and STDOUT filehandles, and examples using
already open filehandles, with explicit examples of where these handles
come from.
* Declare variables with 'my' where appropriate and condense declarations
inline.
* Add comments in synopsis describing the purpose of each example.
* Consistency of referencing synopsis variables from the description.
* Replace ambiguous phrase 'null string' with 'empty string or undefined'
which is also more correct here.
* Add links to referenced CPAN modules and manpages.
* Better describe the reason for using gensym in IPC::Open3 and how to use
it.

-Dan


Thread Previous


nntp.perl.org: Perl Programming lists via nntp and http.
Comments to Ask Bjørn Hansen at ask@perl.org | Group listing | About