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.

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

[doc] FMT_STRING supports C++14 and no-op in C++11 #2620

Merged
merged 2 commits into from
Nov 28, 2021

Conversation

Lounarok
Copy link
Contributor

Hi, I want to use FMT_STRING in a C++11 project and found that FMT_STRING doesn't support C++11.
It emits exception instead of compile time error in this demo.

Then I found that in #2039, @vitaut stated that FMT_STRING a no-op in C++11, but there is no documentation specify this limitation.

I decide to put the requirement in the first line, so one will find the limitation immediately.
So here's my simple PR. Hopefully it doesn't break google's documentation guide line.

doc/api.rst Outdated
@@ -69,6 +69,7 @@ checked at compile time in C++20. To pass a runtime format string wrap it in
Compile-time Format String Checks
---------------------------------

Requires C++14 and it's no-op in C++11.
Copy link
Contributor

Choose a reason for hiding this comment

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

Let's move this to the end of the paragraph because we should first say what FMT_STRING is. Also minor wording tweak:

Requires C++14 and is a no-op in C++11.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks for the brilliant suggestion! It's clearer than before.

@vitaut vitaut merged commit ec3b097 into fmtlib:master Nov 28, 2021
@vitaut
Copy link
Contributor

vitaut commented Nov 28, 2021

Thank you

@Lounarok Lounarok deleted the specify-FMT_STRING-supported-standard branch November 29, 2021 01:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants