AuroraMiddleware/fmtlegacy
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Trying to clear ambiguous compile time claims (#1775)

Browse Source 
* Trying to clear ambiguous compile time claims

Documentation was a bit misleading.
Many people assume that fmt does compile time checks by default, while it requires the use of `FMT_STRING`.
It was also unclear that FMT_COMPILE does the same checks.

https://github.com/fmtlib/fmt/issues/1772

* Update api.rst
This commit is contained in:
Léonard Gérard 2020-07-16 06:19:49 -07:00 committed by GitHub
parent c26349f4d2
commit f5d4215b7c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
doc/api.rst
View File

@ -114,9 +114,9 @@ string checks, wide string, output iterator and user-defined type support.
Compile-time Format String Checks Compile-time Format String Checks
--------------------------------- ---------------------------------
Compile-time checks are supported for built-in and string types as well as Compile-time checks are enabled when using ``FMT_STRING``. They support built-in
user-defined types with ``constexpr`` ``parse`` functions in their ``formatter`` and string types as well as user-defined types with ``constexpr`` ``parse``
specializations. functions in their ``formatter`` specializations.
.. doxygendefine:: FMT_STRING .. doxygendefine:: FMT_STRING
@ -389,9 +389,10 @@ The format string syntax is described in the documentation of
Format string compilation Format string compilation
========================= =========================
``fmt/compile.h`` provides format string compilation support. Format strings ``fmt/compile.h`` provides format string compilation support when using
are parsed at compile time and converted into efficient formatting code. This ``FMT_COMPILE``. Format strings are parsed, checked and converted
supports arguments of built-in and string types as well as user-defined types into efficient formatting code at compile-time.
This supports arguments of built-in and string types as well as user-defined types
with ``constexpr`` ``parse`` functions in their ``formatter`` specializations. with ``constexpr`` ``parse`` functions in their ``formatter`` specializations.
Format string compilation can generate more binary code compared to the default Format string compilation can generate more binary code compared to the default
API and is only recommended in places where formatting is a performance API and is only recommended in places where formatting is a performance