summaryrefslogtreecommitdiff
path: root/doc/string_formatter.rst
diff options
context:
space:
mode:
authorJörg Frings-Fürst <debian@jff-webhosting.net>2023-01-29 16:17:52 +0100
committerJörg Frings-Fürst <debian@jff-webhosting.net>2023-01-29 16:17:52 +0100
commitcd47bd564d7fc6177ba2e231d76bf352978409b8 (patch)
tree7465150c86969e66a90e4b960bb3537485205842 /doc/string_formatter.rst
parent6c88f3bab0b743487b367712fa1ec27d1f87389e (diff)
parentbfef0924f58eab930bdd826ac0132786abc32220 (diff)
Update upstream source from tag 'upstream/4.10'
Update to upstream version '4.10' with Debian dir 3c0b972fcc05149f237318f1a516c1c6bee6ce20
Diffstat (limited to 'doc/string_formatter.rst')
-rw-r--r--doc/string_formatter.rst9
1 files changed, 5 insertions, 4 deletions
diff --git a/doc/string_formatter.rst b/doc/string_formatter.rst
index fdb9c19..77badf8 100644
--- a/doc/string_formatter.rst
+++ b/doc/string_formatter.rst
@@ -116,10 +116,11 @@ Invoking the formatter
Does substituion and directly outputs the expansion to the given stdio
stream.
-On success, the length of the expanded string is returned, excluding the
-trailing ``\0``. While ``HXformat_sprintf`` will not write more than ``size``
-bytes (including the ``\0``), the length it would have taken is returned,
-similar to what sprintf does. On error, ``-errno`` is returned.
+On success, the length of the expanded string is returned (only up to a maximum
+of SSIZE_MAX), excluding the trailing ``\0``. While ``HXformat_sprintf`` will
+not write more than ``size`` bytes (including the ``\0``), the length it would
+have taken is returned, similar to what sprintf does. On error, ``-errno`` is
+returned.
The HXformat function family recognizes make-style like functions and recursive
expansion, described below.