document return value of Getopt::Std::getopts()

Message-ID: <20071123145438.6593.qmail@plover.com>

p4raw-id: //depot/perl@32466

diff --git a/lib/Getopt/Std.pm b/lib/Getopt/Std.pm
index 99f9359..c13d7f6 100644 (file)
--- a/lib/Getopt/Std.pm
+++ b/lib/Getopt/Std.pm
@@ -28,6 +28,7 @@ there is a space between the switch and the argument.
 The getopts() function is similar, but you should pass to it the list of all
 switches to be recognized.  If unspecified switches are found on the
 command-line, the user will be warned that an unknown option was given.
+The getopts() function returns true unless an invalid option was found.
 
 Note that, if your code is running under the recommended C<use strict
 'vars'> pragma, you will need to declare these package variables