Permalink
Browse files

Some improved docs for the new function

  • Loading branch information...
1 parent f7fec05 commit da52d96d018df87062335ba2e27d0c25c9b2c3ab @Whiteknight Whiteknight committed May 22, 2012
Showing with 3 additions and 1 deletion.
  1. +3 −1 src/embed/api.c
View
@@ -429,7 +429,9 @@ handle, Parrot_Int fileno, Parrot_PMC *old_handle)>
Set one of the C<interp_pmc>'s standard IO PMCs. The handle PMC C<handle> is
an IO-type PMC (such as FileHandle or StringHandle). The fileno is one of
C<0> for stdin, C<1> for stdout and C<2> for stderr. Other values are not
-(currently) allowed.
+(currently) allowed. The previous PMC for that handle is returned as
+C<old_handle>. This function returns a true value if this call is successful
+and false value otherwise.
=cut

0 comments on commit da52d96

Please sign in to comment.