From 7483dfc652af47b9c956b10dee688de130f1044a Mon Sep 17 00:00:00 2001 From: Victor Zverovich Date: Wed, 19 May 2021 09:36:12 -0700 Subject: [PATCH] Update signatures --- doc/api.rst | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/doc/api.rst b/doc/api.rst index 01fe3a18..0c32a7d8 100644 --- a/doc/api.rst +++ b/doc/api.rst @@ -35,33 +35,33 @@ using {fmt} as a library and not in the header-only mode. The following functions use :ref:`format string syntax ` similar to that of Python's `str.format `_. -They take *format_str* and *args* as arguments. +They take *fmt* and *args* as arguments. -*format_str* is a format string that contains literal text and replacement +*fmt* is a format string that contains literal text and replacement fields surrounded by braces ``{}``. The fields are replaced with formatted -arguments in the resulting string. A function taking *format_str* doesn't +arguments in the resulting string. A function taking *fmt* doesn't participate in an overload resolution if the latter is not a string. *args* is an argument list representing objects to be formatted. .. _format: -.. doxygenfunction:: format(const S &format_str, Args&&... args) -.. doxygenfunction:: vformat(const S &format_str, basic_format_args>> args) +.. doxygenfunction:: format(format_string fmt, T&&... args) +.. doxygenfunction:: vformat(string_view fmt, format_args args) -.. doxygenfunction:: format_to(OutputIt out, const S&, const Args&... args) -.. doxygenfunction:: format_to_n(OutputIt out, size_t n, const S&, const Args&... args) -.. doxygenfunction:: formatted_size(string_view format_str, Args&&... args) +.. doxygenfunction:: format_to(OutputIt out, format_string fmt, T&& args) +.. doxygenfunction:: format_to_n(OutputIt out, size_t n, format_string fmt, const T&... args) +.. doxygenfunction:: formatted_size(format_string fmt, T&&... args) .. doxygenstruct:: fmt::format_to_n_result :members: .. _print: -.. doxygenfunction:: fmt::print(const S &format_str, Args&&... args) +.. doxygenfunction:: fmt::print(format_string fmt, T&&... args) .. doxygenfunction:: vprint(string_view, format_args) -.. doxygenfunction:: print(std::FILE *f, const S &format_str, Args&&... args) +.. doxygenfunction:: print(std::FILE *f, format_string fmt, T&&... args) .. doxygenfunction:: vprint(std::FILE*, string_view, format_args) Named Arguments