diff options
| author | Rafael Garcia-Suarez <rgarciasuarez@gmail.com> | 2007-09-26 16:57:34 +0000 |
|---|---|---|
| committer | Rafael Garcia-Suarez <rgarciasuarez@gmail.com> | 2007-09-26 16:57:34 +0000 |
| commit | 95b611b0bba585b54c6e7623440a11b1268968e2 (patch) | |
| tree | 7c46f5f18ff1bc0b482bfd6d2bd53d6c0bdbb2cb /pod/perlapi.pod | |
| parent | fbf638cb2f3422c34f7602c75927b8364ccf21ee (diff) | |
| download | perl-95b611b0bba585b54c6e7623440a11b1268968e2.tar.gz | |
API spelling patch, by Jerry D. Hedden
p4raw-id: //depot/perl@31983
Diffstat (limited to 'pod/perlapi.pod')
| -rw-r--r-- | pod/perlapi.pod | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/pod/perlapi.pod b/pod/perlapi.pod index 716c6b102e..13f83df52e 100644 --- a/pod/perlapi.pod +++ b/pod/perlapi.pod @@ -887,21 +887,21 @@ X<pv_pretty> |const U32 flags Converts a string into something presentable, handling escaping via -pv_escape() and supporting quoting and elipses. +pv_escape() and supporting quoting and ellipses. If the PERL_PV_PRETTY_QUOTE flag is set then the result will be double quoted with any double quotes in the string escaped. Otherwise if the PERL_PV_PRETTY_LTGT flag is set then the result be wrapped in angle brackets. -If the PERL_PV_PRETTY_ELIPSES flag is set and not all characters in -string were output then an elipses C<...> will be appended to the +If the PERL_PV_PRETTY_ELLIPSES flag is set and not all characters in +string were output then an ellipsis C<...> will be appended to the string. Note that this happens AFTER it has been quoted. If start_color is non-null then it will be inserted after the opening quote (if there is one) but before the escaped text. If end_color is non-null then it will be inserted after the escaped text but before -any quotes or elipses. +any quotes or ellipses. Returns a pointer to the prettified text as held by dsv. |