perl-module: Document PSPP::Dict::get_var() for too-large index.
authorBen Pfaff <blp@gnu.org>
Mon, 2 Feb 2009 00:30:01 +0000 (16:30 -0800)
committerBen Pfaff <blp@gnu.org>
Mon, 2 Feb 2009 00:30:01 +0000 (16:30 -0800)
Approved by John Darrington.

perl-module/lib/PSPP.pm

index 4eb8c41dd6f7fe36a3b8ec1ce9fe3ff522d9003d..93d70ef20875541427b13dd5038c6331ccaec414 100644 (file)
@@ -90,6 +90,8 @@ sub new
 =head3 get_var ($idx)
 
 Returns the C<idx>th variable from the dictionary.
+Returns undef if C<idx> is greater than or equal to the number
+of variables in the dictionary.
 
 =cut