perldiag: Correct entry about sort sub and single values
authorFather Chrysostomos <sprout@cpan.org>
Tue, 20 Nov 2012 17:56:15 +0000 (09:56 -0800)
committerFather Chrysostomos <sprout@cpan.org>
Wed, 21 Nov 2012 01:58:56 +0000 (17:58 -0800)
Pure-Perl sort subroutines are always called in scalar context, so
it is not possible for them to return more or less than one item.

This entry implies that one would have to be careful about that
when writing a pure-Perl sort routine.

This only applies to XS sort routines, which *do* have to be
careful about that.

pod/perldiag.pod

index 5041e94..1507d6d 100644 (file)
@@ -4529,8 +4529,8 @@ But before sort was a keyword, people sometimes used it as a filehandle.
 
 =item Sort subroutine didn't return single value
 
-(F) A sort comparison subroutine may not return a list value with more
-or less than one element.  See L<perlfunc/sort>.
+(F) A sort comparison subroutine written in XS must return exactly one
+item.  See L<perlfunc/sort>.
 
 =item Source filters apply only to byte streams