From: Ben Pfaff <blp@gnu.org>
Date: Mon, 2 Feb 2009 00:30:01 +0000 (-0800)
Subject: perl-module: Document PSPP::Dict::get_var() for too-large index.
X-Git-Tag: v0.7.2~3
X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?p=pspp-builds.git;a=commitdiff_plain;h=92ddb7c2327432a5b7ca27557eb5727e46a7c9bd

perl-module: Document PSPP::Dict::get_var() for too-large index.

Approved by John Darrington.
---

diff --git a/perl-module/lib/PSPP.pm b/perl-module/lib/PSPP.pm
index 4eb8c41d..93d70ef2 100644
--- a/perl-module/lib/PSPP.pm
+++ b/perl-module/lib/PSPP.pm
@@ -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