Skip to content

Commit fe7d7ed

Browse files
wolfsagejkeenan
authored andcommitted
Correct hv_iterinit's return value documentation
1 parent 275d368 commit fe7d7ed

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

hv.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2172,8 +2172,8 @@ S_hv_auxinit(pTHX_ HV *hv) {
21722172
=for apidoc hv_iterinit
21732173
21742174
Prepares a starting point to traverse a hash table. Returns the number of
2175-
keys in the hash (i.e. the same as C<HvUSEDKEYS(hv)>). The return value is
2176-
currently only meaningful for hashes without tie magic.
2175+
keys in the hash, including placeholders (i.e. the same as C<HvTOTALKEYS(hv)>).
2176+
The return value is currently only meaningful for hashes without tie magic.
21772177
21782178
NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number of
21792179
hash buckets that happen to be in use. If you still need that esoteric

0 commit comments

Comments
 (0)