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

Consider using more "Descriptive variable definitions" tables for requirements #1309

Closed
Eelis opened this issue Jan 1, 2017 · 6 comments · Fixed by #4499
Closed

Consider using more "Descriptive variable definitions" tables for requirements #1309

Eelis opened this issue Jan 1, 2017 · 6 comments · Fixed by #4499

Comments

@Eelis
Copy link
Contributor

Eelis commented Jan 1, 2017

Compare:

The former is nice and clean, while the latter is almost impossible to read.

@jensmaurer
Copy link
Member

jensmaurer commented Jan 1, 2017

Except that the intro text for the variable table isn't stellar:

Table [tab:desc.var.def] describes the types manipulated through allocators.

The table also shows non-type variables.

@jensmaurer
Copy link
Member

jensmaurer commented Jan 1, 2017

That would be a rather large change, since most of the introductory sections for the requirements tables are affected. Maybe we should ask LWG what their preference is.

@jensmaurer jensmaurer added the decision-required A decision of the editorial group (or the Project Editor) is required. label Jan 1, 2017
@Eelis
Copy link
Contributor Author

Eelis commented Jan 2, 2017

A third alternative layout is lists, as in [rand.req.dist]#3.

@jensmaurer
Copy link
Member

Editorial meeting consensus: Re-layout the introductory sections as lists.

@jensmaurer jensmaurer removed the decision-required A decision of the editorial group (or the Project Editor) is required. label Mar 2, 2017
@jensmaurer jensmaurer added the big An issue causing a large set of changes, scattered across most of the text. label Jan 11, 2020
@Eelis
Copy link
Contributor Author

Eelis commented Mar 1, 2021

Ah, I see that the hard-to-read paragraph I originally cited (http://eel.is/c++draft/associative.reqmts.general#8) has now been fixed, sweet!

I also see that the "big" label was applied to this ticket. Are there any remaining hard-to-read paragraphs introducing variables?

@jensmaurer jensmaurer removed the big An issue causing a large set of changes, scattered across most of the text. label Mar 1, 2021
@jensmaurer
Copy link
Member

Fixed by #4499

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 a pull request may close this issue.

2 participants