@@ -123,19 +123,19 @@ const char super_cp_format[] = "Code point 0x%" UVXf " is not Unicode,"
123123=for apidoc_item uvchr_to_utf8_flags_msgs
124124
125125These functions are identical. THEY SHOULD BE USED IN ONLY VERY SPECIALIZED
126- CIRCUMSTANCES.
126+ CIRCUMSTANCES. The C<uv_to_utf8_msgs> spelling is preferred in new code.
127127
128- Most code should use C<L</uv_to_utf8_flags>()> rather than call this directly.
128+ Most code should use C<L</uv_to_utf8_flags>()> rather than call these directly.
129129
130- This function is for code that wants any warning and/or error messages to be
130+ These functions are for code that wants any warning and/or error messages to be
131131returned to the caller rather than be displayed. Any message that would have
132132been displayed if all lexical warnings are enabled will instead be returned.
133133
134- It is just like C<L</uvchr_to_utf8_flags >> but it takes an extra parameter
135- placed after all the others, C<msgs>. If this parameter is 0, this function
136- behaves identically to C<L</uvchr_to_utf8_flags >>. Otherwise, C<msgs> should
137- be a pointer to an C<HV *> variable, in which this function creates a new HV to
138- contain any appropriate message. The hash has three key-value pairs, as
134+ They are just like C<L</uv_to_utf8_flags >> but take an extra parameter
135+ placed after all the others, C<msgs>. If this parameter is 0, the functions
136+ behave identically to C<L</uv_to_utf8_flags >>. Otherwise, C<msgs> should
137+ be a pointer to an C<HV *> variable, in which these functions create a new HV
138+ to contain any appropriate message. The hash has three key-value pairs, as
139139follows:
140140
141141=over 4
@@ -169,7 +169,7 @@ The possibilities are:
169169=back
170170
171171It's important to note that specifying this parameter as non-null will cause
172- any warning this function would otherwise generate to be suppressed, and
172+ any warning the functions would otherwise generate to be suppressed, and
173173instead be placed in C<*msgs>. The caller can check the lexical warnings state
174174(or not) when choosing what to do with the returned message.
175175
0 commit comments