Skip to content

Commit 238a36b

Browse files
closes bpo-46253: Change Py_UNICODE to Py_UCS4 in the C API docs to match the current source code (GH-30387)
(cherry picked from commit 43c5c13) Co-authored-by: Julian Gilbey <[email protected]>
1 parent 690ed88 commit 238a36b

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

Doc/c-api/unicode.rst

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -268,57 +268,57 @@ are available through these macros which are mapped to C functions depending on
268268
the Python configuration.
269269
270270
271-
.. c:function:: int Py_UNICODE_ISSPACE(Py_UNICODE ch)
271+
.. c:function:: int Py_UNICODE_ISSPACE(Py_UCS4 ch)
272272
273273
Return ``1`` or ``0`` depending on whether *ch* is a whitespace character.
274274
275275
276-
.. c:function:: int Py_UNICODE_ISLOWER(Py_UNICODE ch)
276+
.. c:function:: int Py_UNICODE_ISLOWER(Py_UCS4 ch)
277277
278278
Return ``1`` or ``0`` depending on whether *ch* is a lowercase character.
279279
280280
281-
.. c:function:: int Py_UNICODE_ISUPPER(Py_UNICODE ch)
281+
.. c:function:: int Py_UNICODE_ISUPPER(Py_UCS4 ch)
282282
283283
Return ``1`` or ``0`` depending on whether *ch* is an uppercase character.
284284
285285
286-
.. c:function:: int Py_UNICODE_ISTITLE(Py_UNICODE ch)
286+
.. c:function:: int Py_UNICODE_ISTITLE(Py_UCS4 ch)
287287
288288
Return ``1`` or ``0`` depending on whether *ch* is a titlecase character.
289289
290290
291-
.. c:function:: int Py_UNICODE_ISLINEBREAK(Py_UNICODE ch)
291+
.. c:function:: int Py_UNICODE_ISLINEBREAK(Py_UCS4 ch)
292292
293293
Return ``1`` or ``0`` depending on whether *ch* is a linebreak character.
294294
295295
296-
.. c:function:: int Py_UNICODE_ISDECIMAL(Py_UNICODE ch)
296+
.. c:function:: int Py_UNICODE_ISDECIMAL(Py_UCS4 ch)
297297
298298
Return ``1`` or ``0`` depending on whether *ch* is a decimal character.
299299
300300
301-
.. c:function:: int Py_UNICODE_ISDIGIT(Py_UNICODE ch)
301+
.. c:function:: int Py_UNICODE_ISDIGIT(Py_UCS4 ch)
302302
303303
Return ``1`` or ``0`` depending on whether *ch* is a digit character.
304304
305305
306-
.. c:function:: int Py_UNICODE_ISNUMERIC(Py_UNICODE ch)
306+
.. c:function:: int Py_UNICODE_ISNUMERIC(Py_UCS4 ch)
307307
308308
Return ``1`` or ``0`` depending on whether *ch* is a numeric character.
309309
310310
311-
.. c:function:: int Py_UNICODE_ISALPHA(Py_UNICODE ch)
311+
.. c:function:: int Py_UNICODE_ISALPHA(Py_UCS4 ch)
312312
313313
Return ``1`` or ``0`` depending on whether *ch* is an alphabetic character.
314314
315315
316-
.. c:function:: int Py_UNICODE_ISALNUM(Py_UNICODE ch)
316+
.. c:function:: int Py_UNICODE_ISALNUM(Py_UCS4 ch)
317317
318318
Return ``1`` or ``0`` depending on whether *ch* is an alphanumeric character.
319319
320320
321-
.. c:function:: int Py_UNICODE_ISPRINTABLE(Py_UNICODE ch)
321+
.. c:function:: int Py_UNICODE_ISPRINTABLE(Py_UCS4 ch)
322322
323323
Return ``1`` or ``0`` depending on whether *ch* is a printable character.
324324
Nonprintable characters are those characters defined in the Unicode character
@@ -332,43 +332,43 @@ the Python configuration.
332332
These APIs can be used for fast direct character conversions:
333333
334334
335-
.. c:function:: Py_UNICODE Py_UNICODE_TOLOWER(Py_UNICODE ch)
335+
.. c:function:: Py_UCS4 Py_UNICODE_TOLOWER(Py_UCS4 ch)
336336
337337
Return the character *ch* converted to lower case.
338338
339339
.. deprecated:: 3.3
340340
This function uses simple case mappings.
341341
342342
343-
.. c:function:: Py_UNICODE Py_UNICODE_TOUPPER(Py_UNICODE ch)
343+
.. c:function:: Py_UCS4 Py_UNICODE_TOUPPER(Py_UCS4 ch)
344344
345345
Return the character *ch* converted to upper case.
346346
347347
.. deprecated:: 3.3
348348
This function uses simple case mappings.
349349
350350
351-
.. c:function:: Py_UNICODE Py_UNICODE_TOTITLE(Py_UNICODE ch)
351+
.. c:function:: Py_UCS4 Py_UNICODE_TOTITLE(Py_UCS4 ch)
352352
353353
Return the character *ch* converted to title case.
354354
355355
.. deprecated:: 3.3
356356
This function uses simple case mappings.
357357
358358
359-
.. c:function:: int Py_UNICODE_TODECIMAL(Py_UNICODE ch)
359+
.. c:function:: int Py_UNICODE_TODECIMAL(Py_UCS4 ch)
360360
361361
Return the character *ch* converted to a decimal positive integer. Return
362362
``-1`` if this is not possible. This macro does not raise exceptions.
363363
364364
365-
.. c:function:: int Py_UNICODE_TODIGIT(Py_UNICODE ch)
365+
.. c:function:: int Py_UNICODE_TODIGIT(Py_UCS4 ch)
366366
367367
Return the character *ch* converted to a single digit integer. Return ``-1`` if
368368
this is not possible. This macro does not raise exceptions.
369369
370370
371-
.. c:function:: double Py_UNICODE_TONUMERIC(Py_UNICODE ch)
371+
.. c:function:: double Py_UNICODE_TONUMERIC(Py_UCS4 ch)
372372
373373
Return the character *ch* converted to a double. Return ``-1.0`` if this is not
374374
possible. This macro does not raise exceptions.

0 commit comments

Comments
 (0)