diff --git a/doc/index.rst b/doc/index.rst index 715a11ab..ce9b7bf9 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -10,9 +10,9 @@ alternative to C++ IOStreams.
What users say:
- Thanks for creating this library. It’s been a hole in C++ for a long time. - I’ve used both boost::format and loki::SPrintf, and neither felt like the - right answer. This does. + Thanks for creating this library. It’s been a hole in C++ for a long + time. I’ve used both boost::format and loki::SPrintf, and neither felt + like the right answer. This does.
@@ -98,8 +98,8 @@ literal operators, they must be made visible with the directive Write API --------- -The concatenation-based Write API (experimental) provides a -`fast `_ +The concatenation-based Write API (experimental) provides a `fast +`_ stateless alternative to IOStreams: .. code:: c++ @@ -112,8 +112,9 @@ stateless alternative to IOStreams: Safety ------ -The library is fully type safe, automatic memory management prevents buffer overflow, -errors in format strings are reported using exceptions. For example, the code +The library is fully type safe, automatic memory management prevents buffer +overflow, errors in format strings are reported using exceptions. For example, +the code .. code:: c++ @@ -138,19 +139,21 @@ formatted into a narrow string. You can use a wide format string instead: 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 what is needed. +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 what is +needed. .. _portability: Portability ----------- -The library is highly portable. Here is an incomplete list of operating systems and -compilers where it has been tested and known to work: +The library is highly portable. Here is an incomplete list of operating systems +and compilers where it has been tested and known to work: -* 64-bit (amd64) GNU/Linux with GCC 4.4.3, `4.6.3 `_, - 4.7.2, 4.8.1 and Intel C++ Compiler (ICC) 14.0.2 +* 64-bit (amd64) GNU/Linux with GCC 4.4.3, + `4.6.3 `_, 4.7.2, 4.8.1, and Intel C++ + Compiler (ICC) 14.0.2 * 32-bit (i386) GNU/Linux with GCC 4.4.3, 4.6.3 @@ -161,21 +164,21 @@ compilers where it has been tested and known to work: * 32-bit Windows with Visual C++ 2010 -Although the library uses C++11 features when available, it also works with older -compilers and standard library implementations. The only thing to keep in mind -for C++98 portability: +Although the library uses C++11 features when available, it also works with +older compilers and standard library implementations. The only thing to keep in +mind for C++98 portability: * Variadic templates: minimum GCC 4.4, Clang 2.9 or VS2013. This feature allows - the Format API to accept an unlimited number of arguments. With older compilers - the maximum is 15. + the Format API to accept an unlimited number of arguments. With older + compilers the maximum is 15. -* User-defined literals: minimum GCC 4.7, Clang 3.1 or VS2015. The suffixes - ``_format`` and ``_a`` are functionally equivalent to the functions +* User-defined literals: minimum GCC 4.7, Clang 3.1 or VS2015. The suffixes + ``_format`` and ``_a`` are functionally equivalent to the functions ``fmt::format`` and ``fmt::arg``. -The output of all formatting functions is consistent across platforms. In particular, -formatting a floating-point infinity always gives ``inf`` while the output -of ``printf`` is platform-dependent in this case. For example, +The output of all formatting functions is consistent across platforms. In +particular, formatting a floating-point infinity always gives ``inf`` while the +output of ``printf`` is platform-dependent in this case. For example, .. code:: @@ -188,10 +191,10 @@ always prints ``inf``. Ease of Use ----------- -fmt has a small self-contained code base consisting of a single header file -and a single source file and no external dependencies. A permissive BSD `license -`_ allows using the library both -in open-source and commercial projects. +fmt has a small self-contained code base with the core library consisting of +a single header file and a single source file and no external dependencies. +A permissive BSD `license `_ allows +using the library both in open-source and commercial projects. .. raw:: html