This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
pad.h: Correct PadlistMAX docs
authorFather Chrysostomos <sprout@cpan.org>
Wed, 30 Oct 2013 23:54:06 +0000 (16:54 -0700)
committerFather Chrysostomos <sprout@cpan.org>
Wed, 30 Oct 2013 23:54:39 +0000 (16:54 -0700)
They have been wrong since I added them.

pad.h

diff --git a/pad.h b/pad.h
index 2558b7e..32bdb61 100644 (file)
--- a/pad.h
+++ b/pad.h
@@ -179,7 +179,9 @@ The C array of a padlist, containing the pads.  Only subscript it with
 numbers >= 1, as the 0th entry is not guaranteed to remain usable.
 
 =for apidoc Amx|SSize_t|PadlistMAX|PADLIST padlist
-The index of the last pad in the padlist.
+The index of the last allocated space in the padlist.  Note that the last
+pad may be in an earlier slot.  Any entries following it will be NULL in
+that case.
 
 =for apidoc Amx|PADNAMELIST *|PadlistNAMES|PADLIST padlist
 The names associated with pad entries.