Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Trying to clear ambiguous compile time claims #1775

Merged
merged 2 commits into from
Jul 16, 2020
Merged

Trying to clear ambiguous compile time claims #1775

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e3ad200
Trying to clear ambiguous compile time claims
leolchat Jul 15, 2020
d363b72
Update api.rst
leolchat Jul 16, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 10 additions & 6 deletions doc/api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,9 +114,12 @@ string checks, wide string, output iterator and user-defined type support.
Compile-time Format String Checks
---------------------------------

Compile-time checks are supported for built-in and string types as well as
user-defined types with ``constexpr`` ``parse`` functions in their ``formatter``
specializations.
Compile-time checks are enabled when using ``FMT_STRING``. It supports built-in
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It supports -> They support

and string types as well as user-defined types with ``constexpr`` ``parse``
functions in their ``formatter`` specializations.

When the compiler supports UDL templates extensions, using the litteral string
``""_format()`` will also enable compile-time checks.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suggest dropping this part because the extension is obsolete (gcc even warns on it now). FMT_STRING is the only recommended API for compile-time checks.


.. doxygendefine:: FMT_STRING

Expand Down Expand Up @@ -389,9 +392,10 @@ The format string syntax is described in the documentation of
Format string compilation
=========================

``fmt/compile.h`` provides format string compilation support. Format strings
are parsed at compile time and converted into efficient formatting code. This
supports arguments of built-in and string types as well as user-defined types
``fmt/compile.h`` provides format string compilation support when using
``FMT_COMPILE``. Format strings are parsed, checked and converted
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.
Format string compilation can generate more binary code compared to the default
API and is only recommended in places where formatting is a performance
Expand Down