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

std::hash<> could have a clearer index entry #192

Closed
sdutoit opened this issue Sep 20, 2013 · 3 comments
Closed

std::hash<> could have a clearer index entry #192

sdutoit opened this issue Sep 20, 2013 · 3 comments
Labels
index
Milestone
C++14 DIS nice-to...

Comments

@sdutoit
Copy link
Contributor

sdutoit commented Sep 20, 2013

Given that there are many specializations of std::hash<>, the index should clearly point to [unord.hash] for the general description.
@jwakely
Copy link
Member

jwakely commented Sep 21, 2013

It's also a bit difficult to find that it's declared in <functional> if you forget that (as I just found out!) Even if you follow one of the many xrefs to [unord.hash] you then have to go back 22 pages to find the <functional> synopsis that contains it. The section name "unord.hash" gives no clue, and searching for "hash" takes a long time because you have to skip past all the specializations, most of which come earlier in Clause 20. I'm not sure what can be done to improve that though, maybe nothing, the standard isn't meant to be a tutorial or quick reference.

@tkoeppe
Copy link
Contributor

tkoeppe commented Nov 26, 2016

@AlisdairM: Could you please check if this is still a problem?

@jensmaurer
Copy link
Member

The index entry for the library name "hash" now points to the right place.

In order to address the other concern, I'll add a "synopsis" subsection for and add a cross-reference to it.

jensmaurer added a commit to jensmaurer/draft that referenced this issue Dec 7, 2016
@jensmaurer
[function.objects] Introduce a new subsection for the <functional> sy…
f54c9bb 
…nopsis.

Also add a cross-reference from [unord.hash] to the synopsis, which
is the only place where the primary template is declared.

Fixes cplusplus#192.
@jensmaurer jensmaurer mentioned this issue Dec 7, 2016
Merged
tkoeppe pushed a commit that referenced this issue Dec 7, 2016
@jensmaurer @tkoeppe
[function.objects] Introduce a new subsection for the <functional> sy…
4975167 
…nopsis. (#1179)

Also add a cross-reference from [unord.hash] to the synopsis, which
is the only place where the primary template is declared.

Fixes #192.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
index
Projects
None yet
Milestone
C++14 DIS nice-to-haves
Development

No branches or pull requests
4 participants
@sdutoit @jwakely @tkoeppe @jensmaurer