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

"pre:" and "post:" in container requirements tables #792

Closed
jwakely opened this issue Jul 5, 2016 · 4 comments
Closed

"pre:" and "post:" in container requirements tables #792

jwakely opened this issue Jul 5, 2016 · 4 comments
Assignees
@jensmaurer
Labels
formatting

Comments

@jwakely
Copy link
Member

jwakely commented Jul 5, 2016

The container requirements tables introduce preconditions and postconditions with "pre:" and "post:", or sometimes "Pre:" and "Post:". Those are not italicized like Effects: etc. (and are not using LaTeX commands, just plain text, so are harder to see in the source).

We should format them consistently.

A better solution might fall out of @tkoeppe's suggestion on Issue #78 if we get rid of the tables, as we could use real Requires: and Postconditions: elements once we aren't constrained by the column width in those tables.
@jlaire jlaire mentioned this issue Dec 14, 2016
Closed
@jensmaurer
Copy link
Member

jensmaurer commented Dec 18, 2016 •
edited

In [unord.req], we use "Pre:" as well as "Requires:". Can someone clue me in what the (supposed) difference is?

@jwakely
Copy link
Member Author

jwakely commented Dec 19, 2016 •
edited

No idea, I think it's just historical baggage, from a time when we were less formal about such things. The "pre:" entries are very old, the [unord.req] ones were added later, via TR1.

It would be good to clean it up before (or as part of) P0411 Separating Library Requirements and Preconditions

@jensmaurer
Copy link
Member

jensmaurer commented Dec 19, 2016 •
edited

@jwakely: Ok, so replacing pre/post with \Requires and \Postcondition right now would put us in a good starting position for further massaging by P0411, right?

@jwakely
Copy link
Member Author

jwakely commented Dec 19, 2016

Yes, I think so. My guess is that pre/post were used just to avoid wasting space in those table cells, for layout reasons.

jensmaurer added a commit to jensmaurer/draft that referenced this issue Dec 19, 2016
@jensmaurer
[containers] Replace pre: and post: in requirements tables
6cb16e4 
with \requires and \postcondition, respectively.

Fixes cplusplus#792.
@jensmaurer jensmaurer mentioned this issue Dec 19, 2016
Merged
@jensmaurer jensmaurer self-assigned this Dec 19, 2016
tkoeppe pushed a commit that referenced this issue Dec 20, 2016
@jensmaurer @tkoeppe
[containers] Replace pre: and post: in requirements tables with \requ…
d49359b 
…ires and \postcondition, respectively. (#1273)

Fixes #792.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jensmaurer jensmaurer

Labels
formatting
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@jwakely @jensmaurer