develooper Front page | perl.perl5.porters | Postings from December 2011

[perl #22960] Tie::Handle documentation inadequate

Thread Next
James E Keenan via RT
December 1, 2011 19:30
[perl #22960] Tie::Handle documentation inadequate
Message ID:
On Sun Jul 13 22:36:28 2003, ed wrote:
> The pod documentation for Tie::Handle lists the methods to be
> implemented but it doesn't say what the return value should be from
> each method, nor what they should do in case of error (die, or return
> undef, or whatever).
> Also it mentions that Tie::Handle provides a default new() but doesn't
> say what kind of object is generated (for example, an anonymous hash).
> If writing a subclass you need to know that.
> It would help to have a small working example in the SYNOPSIS, such as
> a tied filehandle with does ROT13 on input and output.  That would
> serve to document the return values and error cases.  If it turns out
> that most of the methods are implemented as thin wrappers around the
> corresponding Perl builtins, that's still useful documentation.

The documentation currently (5.14.2) shown with 'perldoc Tie::Handle'
points in two locations to 'perldoc perltie'.  The latter has a large
section on "Tying Handles."

Would the "Tying Handles" discussion address the original poster's concerns?

Thank you very much.
Jim Keenan

Thread Next Perl Programming lists via nntp and http.
Comments to Ask Bjørn Hansen at | Group listing | About