Update docs

This commit is contained in:
Victor Zverovich 2021-06-02 07:46:26 -07:00
parent 622d1c0423
commit faf972f039

View File

@ -31,16 +31,18 @@ Python:
.. code:: c++ .. code:: c++
fmt::format("The answer is {}.", 42); std::string s = fmt::format("The answer is {}.", 42);
The ``fmt::format`` function returns a string "The answer is 42.". You can use The ``fmt::format`` function returns a string "The answer is 42.". You can use
``fmt::memory_buffer`` to avoid constructing ``std::string``: ``fmt::memory_buffer`` to avoid constructing ``std::string``:
.. code:: c++ .. code:: c++
fmt::memory_buffer out; auto out = fmt::memory_buffer();
format_to(out, "For a moment, {} happened.", "nothing"); format_to(std::back_inserter(out),
out.data(); // returns a pointer to the formatted data "For a moment, {} happened.", "nothing");
auto data = out.data(); // pointer to the formatted data
auto size = out.size(); // size of the formatted data
The ``fmt::print`` function performs formatting and writes the result to a stream: The ``fmt::print`` function performs formatting and writes the result to a stream:
@ -108,16 +110,10 @@ The following code
fmt::format("Cyrillic letter {}", L'\x42e'); fmt::format("Cyrillic letter {}", L'\x42e');
produces a compile-time error because wide character ``L'\x42e'`` cannot be produces a compile-time error because wide character ``L'\x42e'`` cannot be
formatted into a narrow string. You can use a wide format string instead: formatted into a narrow string. For comparison, writing a wide character to
``std::ostream`` results in its numeric value being written to the stream
.. code:: c++ (i.e. 1070 instead of letter 'ю' which is represented by ``L'\x42e'`` if we
use Unicode) which is rarely desirable.
fmt::format(L"Cyrillic letter {}", L'\x42e');
For comparison, writing a wide character to ``std::ostream`` results in
its numeric value being written to the stream (i.e. 1070 instead of letter 'ю'
which is represented by ``L'\x42e'`` if we use Unicode) which is rarely
desirable.
Compact Binary Code Compact Binary Code
------------------- -------------------