diff options
author | Matthew Horsfall <WolfSage@gmail.com> | 2014-03-11 15:59:15 -0400 |
---|---|---|
committer | James E Keenan <jkeenan@cpan.org> | 2017-02-28 07:45:26 -0500 |
commit | fe7d7ed30f61366a4cfdd0edc6051ffc736a572a (patch) | |
tree | c120b1bf7e197ae07932ea96b3705e76a0867392 /hv.c | |
parent | 275d368b86effce470e1f872f4c3e0a5af1fec93 (diff) | |
download | perl-fe7d7ed30f61366a4cfdd0edc6051ffc736a572a.tar.gz |
Correct hv_iterinit's return value documentation
Diffstat (limited to 'hv.c')
-rw-r--r-- | hv.c | 4 |
1 files changed, 2 insertions, 2 deletions
@@ -2172,8 +2172,8 @@ S_hv_auxinit(pTHX_ HV *hv) { =for apidoc hv_iterinit Prepares a starting point to traverse a hash table. Returns the number of -keys in the hash (i.e. the same as C<HvUSEDKEYS(hv)>). The return value is -currently only meaningful for hashes without tie magic. +keys in the hash, including placeholders (i.e. the same as C<HvTOTALKEYS(hv)>). +The return value is currently only meaningful for hashes without tie magic. NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number of hash buckets that happen to be in use. If you still need that esoteric |