Skip to content

cross-references needed to library types and their requirements #696

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
Closed
burblebee opened this issue Apr 14, 2016 · 5 comments
Closed

cross-references needed to library types and their requirements #696

burblebee opened this issue Apr 14, 2016 · 5 comments
Assignees
@jensmaurer

Comments

@burblebee
Copy link
Contributor

What are the requirements of the referred-to library types mentioned in [alg.random.sample]/1 and elsewhere? For example, what are the requirements of an InputIterator type mentioned in Bullet 1.1:
"... shall meet the requirements of an InputIterator type"?
A reference would be very useful for all such types.
Grep in Latex for "shall meet the .*requirements of" to see list of all occurrences (some do have references).

Also, I could find nothing in the index for the types themselves (like InputIterator). Cross-references for each should be added.

e-mail from Richard:

This seems editorial. We should add cross-references here and make sure that the library concept names end up in the index.
@timsong-cpp
Copy link
Contributor

MeowIterators are not concepts proper, so these should probably use the wording in [algorithms.general]/5 ("shall satisfy the requirements of a meow iterator" with a cross link to [meow.iterators]).

@jwakely
Copy link
Member

jwakely commented Apr 14, 2016

Also, I could find nothing in the index for the types themselves (like InputIterator).

Because they aren't types. Tim Song's suggestion is the correct way to say it.

@burblebee
Copy link
Contributor Author

Thanks for clarifying. Tim Song, would you mind taking this one please?

@geoffromer geoffromer mentioned this issue Apr 15, 2016
Closed
timsong-cpp pushed a commit to timsong-cpp/draft that referenced this issue Apr 15, 2016
[alg.random.sample] reword and add cross-reference
60a12c0 
MeowIterator is not a named requirement, so reworded as "shall satisfy
the requirements of a meow iterator", consistent with the wording in
[algorithm.general]/5. Added cross-references to [meow.iterators], and
to [iterator.requirements.general] for "writable".

Partially addresses cplusplus#697 and cplusplus#696.
@timsong-cpp timsong-cpp mentioned this issue Apr 15, 2016
Merged
timsong-cpp added a commit to timsong-cpp/draft that referenced this issue Apr 15, 2016
@timsong-cpp
[alg.random.sample] reword and add cross-reference
4f10be6 
MeowIterator is not a named requirement, so reworded as "shall satisfy
the requirements of a meow iterator", consistent with the wording in
[algorithm.general]/5. Added cross-references to [meow.iterators], and
to [iterator.requirements.general] for "writable".

Partially addresses cplusplus#697 and cplusplus#696.
timsong-cpp added a commit to timsong-cpp/draft that referenced this issue Apr 15, 2016
@timsong-cpp
[alg.random.sample] reword and add cross-reference
e9134bd 
MeowIterator is not a named requirement, so reworded as "shall satisfy
the requirements of a meow iterator", consistent with the wording in
[algorithms.general]/5. Added cross-references to [meow.iterators], and
to [iterator.requirements.general] for "writable".

Partially addresses cplusplus#697 and cplusplus#696.
zygoloid pushed a commit that referenced this issue May 30, 2016
@timsong-cpp @zygoloid
[alg.random.sample] reword and add cross-reference (#705)
0560bab 
MeowIterator is not a named requirement, so reworded as "shall satisfy
the requirements of a meow iterator", consistent with the wording in
[algorithms.general]/5. Added cross-references to [meow.iterators], and
to [iterator.requirements.general] for "writable".

Partially addresses #697 and #696.
FrankHB pushed a commit to FrankHB/draft that referenced this issue Jul 9, 2016
@timsong-cpp @FrankHB
[alg.random.sample] reword and add cross-reference (cplusplus#705)
ede7e30 
MeowIterator is not a named requirement, so reworded as "shall satisfy
the requirements of a meow iterator", consistent with the wording in
[algorithms.general]/5. Added cross-references to [meow.iterators], and
to [iterator.requirements.general] for "writable".

Partially addresses cplusplus#697 and cplusplus#696.
@jensmaurer jensmaurer mentioned this issue Dec 16, 2016
Closed
@jensmaurer
Copy link
Member

We say both "shall satisfy the requirements..." (55 times) and "shall meet the requirements..." (24 times). [Both counts are the results of a simple "grep".]

@jensmaurer
Copy link
Member

I've split off the phrasing questions for \tcode concepts (e.g. CopyConstructible) into #1263. This issue now exclusively deals with iterator requirements.

jensmaurer added a commit to jensmaurer/draft that referenced this issue Dec 16, 2016
@jensmaurer
[lib] Harmonize casing for 'shall meet the requirements of ... iterat…
1554dd0 
…or'.

Also cross-reference the sections, not the tables, for
iterator requirements.

Fixes cplusplus#696.
@jensmaurer jensmaurer mentioned this issue Dec 16, 2016
Merged
@jensmaurer jensmaurer self-assigned this Dec 20, 2016
zygoloid pushed a commit that referenced this issue Feb 5, 2017
@jensmaurer @zygoloid
[lib] Harmonize casing for 'shall meet the requirements of ... iterat…
4b0d533 
…or'.

Also cross-reference the sections, not the tables, for
iterator requirements.

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

@jensmaurer jensmaurer

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@jwakely @burblebee @timsong-cpp @jensmaurer