Skip to content

Commit cd791bd

Browse files
committed
perlguts: document HvNAMEfARG
The docs for HvNAMEf failed to mention the name of the macro to use to pass the argument for the format string.
1 parent d56c1ca commit cd791bd

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

pod/perlguts.pod

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3290,11 +3290,13 @@ messages where the string is assumed to be a class name.
32903290

32913291
=for apidoc Amnh||HvNAMEf
32923292
=for apidoc Amnh||HvNAMEf_QUOTEDPREFIX
3293+
=for apidoc Amh||HvNAMEfARG|HV *hv
32933294

32943295
C<HvNAMEf> and C<HvNAMEf_QUOTEDPREFIX> are similar to C<SVf> except they
3295-
extract the string, length and utf8 flags from the argument using the
3296-
C<HvNAME()>, C<HvNAMELEN()>, C<HvNAMEUTF8()> macros. This is intended
3297-
for stringifying a class name directly from an stash HV.
3296+
extract the string, length and utf8 flags from the argument given to
3297+
C<HvNAMEfARG()> using the C<HvNAME()>, C<HvNAMELEN()>, C<HvNAMEUTF8()>
3298+
macros. This is intended for stringifying a class name directly from an
3299+
stash HV.
32983300

32993301
=head2 Formatted Printing of Strings
33003302

0 commit comments

Comments
 (0)