diff options
| author | Karl Williamson <khw@cpan.org> | 2022-02-17 13:30:49 -0700 |
|---|---|---|
| committer | Karl Williamson <khw@cpan.org> | 2022-02-24 11:08:30 -0700 |
| commit | 714a0a851bee9b5ed8d5e0f66865bf3bb1d2bbc5 (patch) | |
| tree | 532e62e7852fd3b03907048177e9b2bc2ae64a6b /intrpvar.h | |
| parent | 56e374c790f454d328a39a52eda5a63d41fe4ca9 (diff) | |
| download | perl-714a0a851bee9b5ed8d5e0f66865bf3bb1d2bbc5.tar.gz | |
perlapi: Improve pod for Perl_na
Diffstat (limited to 'intrpvar.h')
| -rw-r--r-- | intrpvar.h | 13 |
1 files changed, 9 insertions, 4 deletions
diff --git a/intrpvar.h b/intrpvar.h index 6f993e6b92..33fc086110 100644 --- a/intrpvar.h +++ b/intrpvar.h @@ -240,10 +240,15 @@ PERLVAR(I, stashcache, HV *) /* Cache to speed up S_method_common */ /* =for apidoc Amn|STRLEN|PL_na -A convenience variable which is typically used with C<SvPV> when one -doesn't care about the length of the string. It is usually more efficient -to either declare a local variable and use that instead or to use the -C<SvPV_nolen> macro. +A scratch pad variable in which to store a C<STRLEN> value. If would have been +better named something like C<PL_temp_strlen>. + +It is is typically used with C<SvPV> when one is actually planning to discard +the returned length, (hence the length is "Not Applicable", which is how this +variable got its name). + +It is usually more efficient to either declare a local variable and use that +instead, or to use the C<SvPV_nolen> macro. =cut */ |