summaryrefslogtreecommitdiffstats
path: root/Doc/c-api
diff options
context:
space:
mode:
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>2021-02-19 15:55:44 (GMT)
committerGitHub <noreply@github.com>2021-02-19 15:55:44 (GMT)
commit1cfed3d5b0ec1419c8a1d5cf8bff1a6e1483771a (patch)
treeee76a82ade90ff4d602a9004ca9b9bcf71b931ef /Doc/c-api
parent8cc6e27bd61c51daad56a98c1c75b1fd3345feb1 (diff)
downloadcpython-1cfed3d5b0ec1419c8a1d5cf8bff1a6e1483771a.zip
cpython-1cfed3d5b0ec1419c8a1d5cf8bff1a6e1483771a.tar.gz
cpython-1cfed3d5b0ec1419c8a1d5cf8bff1a6e1483771a.tar.bz2
closes bpo-43266: Improve array formatting. (GH-24573)
(cherry picked from commit 2d3e463e4a5aa109d1c15c86f9631580f5ef7a7e) Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no>
Diffstat (limited to 'Doc/c-api')
-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 ee76acc..0cc836b 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`` and ``format !=
NULL``.
@@ -38,13 +38,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.