summaryrefslogtreecommitdiffstats
path: root/Doc/c-api/unicode.rst
diff options
context:
space:
mode:
authorVictor Stinner <vstinner@python.org>2020-08-13 17:16:02 (GMT)
committerGitHub <noreply@github.com>2020-08-13 17:16:02 (GMT)
commit46d10b1237c67ff8347f533eda6a5468d098f7eb (patch)
tree5f202a738a0f01b2cb5c5cb365415c8a85057b95 /Doc/c-api/unicode.rst
parent43577c01a2ab49122db696e9eaec6cb31d11cc81 (diff)
downloadcpython-46d10b1237c67ff8347f533eda6a5468d098f7eb.zip
cpython-46d10b1237c67ff8347f533eda6a5468d098f7eb.tar.gz
cpython-46d10b1237c67ff8347f533eda6a5468d098f7eb.tar.bz2
bpo-40204: Fix duplicates in the documentation (GH-21857)
Fix two Sphinx 3 issues: Doc/c-api/buffer.rst:304: WARNING: Duplicate C declaration, also defined in 'c-api/buffer'. Declaration is 'PyBUF_ND'. Doc/c-api/unicode.rst:1603: WARNING: Duplicate C declaration, also defined in 'c-api/unicode'. Declaration is 'PyObject* PyUnicode_Translate(PyObject *str, PyObject *table, const char *errors)'.
Diffstat (limited to 'Doc/c-api/unicode.rst')
-rw-r--r--Doc/c-api/unicode.rst37
1 files changed, 12 insertions, 25 deletions
diff --git a/Doc/c-api/unicode.rst b/Doc/c-api/unicode.rst
index f3f0c4c..577cdf2 100644
--- a/Doc/c-api/unicode.rst
+++ b/Doc/c-api/unicode.rst
@@ -1487,17 +1487,21 @@ These are the mapping codec APIs:
The following codec API is special in that maps Unicode to Unicode.
-.. c:function:: PyObject* PyUnicode_Translate(PyObject *unicode, \
- PyObject *mapping, const char *errors)
+.. c:function:: PyObject* PyUnicode_Translate(PyObject *str, PyObject *table, const char *errors)
- Translate a Unicode object using the given *mapping* object and return the
- resulting Unicode object. Return ``NULL`` if an exception was raised by the
+ Translate a string by applying a character mapping table to it and return the
+ resulting Unicode object. Return ``NULL`` if an exception was raised by the
codec.
- The *mapping* object must map Unicode ordinal integers to Unicode strings,
- integers (which are then interpreted as Unicode ordinals) or ``None``
- (causing deletion of the character). Unmapped character ordinals (ones
- which cause a :exc:`LookupError`) are left untouched and are copied as-is.
+ The mapping table must map Unicode ordinal integers to Unicode ordinal integers
+ or ``None`` (causing deletion of the character).
+
+ Mapping tables need only provide the :meth:`__getitem__` interface; dictionaries
+ and sequences work well. Unmapped character ordinals (ones which cause a
+ :exc:`LookupError`) are left untouched and are copied as-is.
+
+ *errors* has the usual meaning for codecs. It may be ``NULL`` which indicates to
+ use the default error handling.
.. c:function:: PyObject* PyUnicode_TranslateCharmap(const Py_UNICODE *s, Py_ssize_t size, \
@@ -1600,23 +1604,6 @@ They all return ``NULL`` or ``-1`` if an exception occurs.
characters are not included in the resulting strings.
-.. c:function:: PyObject* PyUnicode_Translate(PyObject *str, PyObject *table, \
- const char *errors)
-
- Translate a string by applying a character mapping table to it and return the
- resulting Unicode object.
-
- The mapping table must map Unicode ordinal integers to Unicode ordinal integers
- or ``None`` (causing deletion of the character).
-
- Mapping tables need only provide the :meth:`__getitem__` interface; dictionaries
- and sequences work well. Unmapped character ordinals (ones which cause a
- :exc:`LookupError`) are left untouched and are copied as-is.
-
- *errors* has the usual meaning for codecs. It may be ``NULL`` which indicates to
- use the default error handling.
-
-
.. c:function:: PyObject* PyUnicode_Join(PyObject *separator, PyObject *seq)
Join a sequence of strings using the given *separator* and return the resulting