Trying to clear ambiguous compile time claims #1775
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. fmtlib#1772
vitaut
requested changes
Jul 16, 2020
doc/api.rst
Outdated
| 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 |
There was a problem hiding this comment.
It supports -> They support
doc/api.rst
Outdated
Comment on lines
121
to
122
| When the compiler supports UDL templates extensions, using the litteral string | ||
| ``""_format()`` will also enable compile-time checks. |
There was a problem hiding this comment.
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.
|
Thanks |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Documentation was a bit misleading. Many people quickly assume that fmt does compile time checks by default, while it requires the use of
FMT_STRING. It was also unclear thatFMT_COMPILEdoes the same checks.See initial discussion here: #1772
I agree that my contributions are licensed under the {fmt} license, and agree to future changes to the licensing.