summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorErlend Egeberg Aasland <erlend.aasland@innova.no>2021-02-19 15:32:31 (GMT)
committerGitHub <noreply@github.com>2021-02-19 15:32:31 (GMT)
commit2d3e463e4a5aa109d1c15c86f9631580f5ef7a7e (patch)
tree6a8af27a58b65963f41d4b61802bb685c4a5d867
parent4a6bf276ed3e6687394afe26b0d9a061ac06fc6b (diff)
downloadcpython-2d3e463e4a5aa109d1c15c86f9631580f5ef7a7e.zip
cpython-2d3e463e4a5aa109d1c15c86f9631580f5ef7a7e.tar.gz
cpython-2d3e463e4a5aa109d1c15c86f9631580f5ef7a7e.tar.bz2
closes bpo-43266: Improve array formatting. (GH-24573)
-rw-r--r--Doc/c-api/conversion.rst8
1 files changed, 4 insertions, 4 deletions
diff --git a/Doc/c-api/conversion.rst b/Doc/c-api/conversion.rst
index e47072f..7b4cc1c 100644
--- a/Doc/c-api/conversion.rst
+++ b/Doc/c-api/conversion.rst
@@ -25,7 +25,7 @@ functions :c:func:`snprintf` and :c:func:`vsnprintf`. Their purpose is to
guarantee consistent behavior in corner cases, which the Standard C functions do
not.
-The wrappers ensure that *str*[*size*-1] is always ``'\0'`` upon return. They
+The wrappers ensure that ``str[size-1]`` is always ``'\0'`` upon return. They
never write more than *size* bytes (including the trailing ``'\0'``) into str.
Both functions require that ``str != NULL``, ``size > 0``, ``format != NULL``
and ``size < INT_MAX``.
@@ -34,13 +34,13 @@ The return value (*rv*) for these functions should be interpreted as follows:
* When ``0 <= rv < size``, the output conversion was successful and *rv*
characters were written to *str* (excluding the trailing ``'\0'`` byte at
- *str*[*rv*]).
+ ``str[rv]``).
* When ``rv >= size``, the output conversion was truncated and a buffer with
- ``rv + 1`` bytes would have been needed to succeed. *str*[*size*-1] is ``'\0'``
+ ``rv + 1`` bytes would have been needed to succeed. ``str[size-1]`` is ``'\0'``
in this case.
-* When ``rv < 0``, "something bad happened." *str*[*size*-1] is ``'\0'`` in
+* When ``rv < 0``, "something bad happened." ``str[size-1]`` is ``'\0'`` in
this case too, but the rest of *str* is undefined. The exact cause of the error
depends on the underlying platform.