diff options
Diffstat (limited to 'doc/string_formatter.rst')
| -rw-r--r-- | doc/string_formatter.rst | 9 |
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. |