External/fmt
8
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

cleanup doc string

Browse Source
This commit is contained in:
Walter Gray 2020-12-07 21:21:17 -08:00
parent b61537a9df
commit d539f76da6
1 changed files with 4 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
doc/api.rst
View File

@ -165,13 +165,10 @@ functions in their ``formatter`` specializations.
.. _udt:
Enforcing Compile-time Format Checks
------------------------------------
To force the use of Compile-time checks, compile with
``FMT_ENFORCE_COMPILE_STRING`` defined. When this preprocessor definition is
given, functions accepting ``FMT_STRING`` will fail to compile with regular
strings. When this is set, runtime-checked formatting is still possible using
``fmt::vformat``, ``fmt::vprint``, etc.
To force the use of compile-time checks, define the preprocessor variable
``FMT_ENFORCE_COMPILE_STRING``. When set, functions accepting ``FMT_STRING``
will fail to compile with regular strings. Runtime-checked
formatting is still possible using ``fmt::vformat``, ``fmt::vprint``, etc.
Formatting User-defined Types
-----------------------------