Front page | perl.perl5.porters |
Postings from September 2003
[perl #22960] Tie::Handle documentation inadequate http://rt.perl.org/rt2/Ticket/Display.html?id=22960 > 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. -- Jarkko Hietaniemi <jhi@iki.fi> http://www.iki.fi/jhi/ "There is this special biologist word we use for 'stable'. It is 'dead'." -- Jack CohenThread Next