[Python-checkins] closes bpo-43266: Improve array formatting. (GH-24573)
benjaminp
webhook-mailer at python.org
Fri Feb 19 10:32:52 EST 2021
https://github.com/python/cpython/commit/2d3e463e4a5aa109d1c15c86f9631580f5ef7a7e
commit: 2d3e463e4a5aa109d1c15c86f9631580f5ef7a7e
branch: master
author: Erlend Egeberg Aasland <erlend.aasland at innova.no>
committer: benjaminp <benjamin at python.org>
date: 2021-02-19T09:32:31-06:00
summary:
closes bpo-43266: Improve array formatting. (GH-24573)
files:
M Doc/c-api/conversion.rst
diff --git a/Doc/c-api/conversion.rst b/Doc/c-api/conversion.rst
index e47072f04747a..7b4cc1cacdd4a 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.
More information about the Python-checkins
mailing list