This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
[perl #117791] Clarify that write does not match the C 'write' semantics
authorDominic Hargreaves <dom@earth.li>
Sun, 28 Apr 2013 21:11:57 +0000 (22:11 +0100)
committerDominic Hargreaves <dom@earth.li>
Tue, 7 May 2013 22:14:11 +0000 (23:14 +0100)
dist/IO/lib/IO/Handle.pm

index 68e6d90..3b1e67d 100644 (file)
@@ -139,9 +139,12 @@ guaranteed.
 
 =item $io->write ( BUF, LEN [, OFFSET ] )
 
-This C<write> is like C<write> found in C, that is it is the
+This C<write> is somewhat like C<write> found in C, in that it is the
 opposite of read. The wrapper for the perl C<write> function is
-called C<format_write>.
+called C<format_write>. However, whilst the C C<write> function returns
+the number of bytes written, this C<write> function simply returns true
+if successful (like C<print>). A more C-like C<write> is C<syswrite>
+(see above).
 
 =item $io->error