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

[version.syn] Add synopsis for <version> header. #3163

Merged
merged 1 commit into from Oct 7, 2019

Conversation

jensmaurer
Copy link
Member

Fixes #3147.

@jensmaurer
Copy link
Member Author

@zygoloid , did you have something like this in mind?

@CaseyCarter
Copy link
Contributor

Alternately, we could eliminate the table and make the definitions explicit in the synopsis:

#define __cpp_lib_concepts 201806L // Also in: <concepts>

It seems silly to have a synopsis with simply // what the table says, and equally silly to have a table to depict things that we could as easily declare directly.

@zygoloid
Copy link
Member

I like @CaseyCarter's suggestion. Let's try treating these like any other macro the library provides.

@jensmaurer jensmaurer added needs rebase The pull request needs a git rebase to resolve merge conflicts. changes requested Changes to the wording or approach have been requested and not yet applied. labels Sep 30, 2019
@jensmaurer jensmaurer removed changes requested Changes to the wording or approach have been requested and not yet applied. needs rebase The pull request needs a git rebase to resolve merge conflicts. labels Oct 2, 2019
@jensmaurer
Copy link
Member Author

Here's how a proper synopsis with #define would look like:

version

@jensmaurer
Copy link
Member Author

If desired, I can add section cross-references after each mention of a header. Please advise.

@jwakely
Copy link
Member

jwakely commented Oct 2, 2019

IMO the cross-references would look cluttered (especially if given on every mention of a header, not just the first mention).

@zygoloid
Copy link
Member

zygoloid commented Oct 6, 2019

I like this. Has anyone already done a pass over a before and after document to check that the macros and versions all match? This seems like an easy change for a typo to slip into unnoticed.

source/support.tex Outdated Show resolved Hide resolved
source/support.tex Outdated Show resolved Hide resolved
source/support.tex Outdated Show resolved Hide resolved
@CaseyCarter
Copy link
Contributor

Has anyone already done a pass over a before and after document to check that the macros and versions all match?

I have just performed such a pass; it's all good.

@zygoloid zygoloid added the changes requested Changes to the wording or approach have been requested and not yet applied. label Oct 6, 2019
@jensmaurer jensmaurer removed the changes requested Changes to the wording or approach have been requested and not yet applied. label Oct 6, 2019
Copy link
Contributor

@CaseyCarter CaseyCarter left a comment

Choose a reason for hiding this comment

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

LGTM!

source/support.tex Outdated Show resolved Hide resolved
@zygoloid zygoloid added the changes requested Changes to the wording or approach have been requested and not yet applied. label Oct 6, 2019
This replaces the table of feature-test macros for the library.
@jensmaurer jensmaurer removed the changes requested Changes to the wording or approach have been requested and not yet applied. label Oct 7, 2019
@zygoloid zygoloid merged commit 2c2b292 into cplusplus:master Oct 7, 2019
@jensmaurer jensmaurer deleted the c2 branch October 7, 2019 19:47
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.

missing synopsis for <version> header
4 participants