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

clarify BuilderHasherDefault summary #31242

Closed
tshepang opened this issue Jan 27, 2016 · 7 comments
Closed

clarify BuilderHasherDefault summary #31242

tshepang opened this issue Jan 27, 2016 · 7 comments
Labels
E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. E-help-wanted Call for participation: Help is requested to fix this issue. E-mentor Call for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion.

Comments

@tshepang
Copy link
Member

This line is not clear:

A structure which implements BuildHasher for all Hasher types which also implement Default.

I don't know if BuilderHasherDefault implements BuilderHasher and Default for Hasher types, or if it implements BuilderHasher for Hasher types that themselves implement Default.

@steveklabnik
Copy link
Member

@alexcrichton any thoughts on making the semantics here more clear? I'm not mega familiar with the Hash stuff.

@alexcrichton
Copy link
Member

I was basically just attempting with words to describe the trait impls on BuildHasherDefault, but as @aturon was also confused by the wording I guess it definitely didn't get the point across!

@steveklabnik steveklabnik added E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. E-mentor Call for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion. E-help-wanted Call for participation: Help is requested to fix this issue. labels Jun 27, 2016
@steveklabnik
Copy link
Member

I would be happy to work with anyone who wants to work on this issue.

@adrianbrink
Copy link

@steveklabnik I would be glad to help out :-) What's the best way to start on this?

I am trying to find the source for the docs and I am ending up here, but somehow I think I am wrong.

@steveklabnik
Copy link
Member

Hey @adrianbrink ! Thanks :)

That's the directory for all of the long-form docs. The API documentation is in the source. With this specific bit of docs, it's here:

/// A structure which implements `BuildHasher` for all `Hasher` types which also
/// implement `Default`.
///
/// This struct is 0-sized and does not need construction.
#[stable(since = "1.7.0", feature = "build_hasher")]

So modifying these lines is where you need to go! Feel free to take a shot at it and just open a PR; we can workshop specific wording if you'd like in the PR itself. 😄

@frewsxcv
Copy link
Member

Opened a PR for this: #38334.

@frewsxcv
Copy link
Member

Oh sorry, I just realized now that it's tagged E-Easy. Had I noticed this earlier, I wouldn't have worked on it, sorry about that!

GuillaumeGomez added a commit to GuillaumeGomez/rust that referenced this issue Dec 15, 2016
…laumeGomez

Rewrite, improve documentation for `core::hash::BuildHasherDefault`.

Fixes rust-lang#31242.
GuillaumeGomez added a commit to GuillaumeGomez/rust that referenced this issue Dec 16, 2016
…laumeGomez

Rewrite, improve documentation for `core::hash::BuildHasherDefault`.

Fixes rust-lang#31242.
GuillaumeGomez added a commit to GuillaumeGomez/rust that referenced this issue Dec 18, 2016
…laumeGomez

Rewrite, improve documentation for `core::hash::BuildHasherDefault`.

Fixes rust-lang#31242.
sanxiyn added a commit to sanxiyn/rust that referenced this issue Dec 19, 2016
…laumeGomez

Rewrite, improve documentation for `core::hash::BuildHasherDefault`.

Fixes rust-lang#31242.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. E-help-wanted Call for participation: Help is requested to fix this issue. E-mentor Call for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion.
Projects
None yet
Development

No branches or pull requests

5 participants