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

Fill in documentation for HashSet. #15772

Merged
merged 2 commits into from
Jul 19, 2014
Merged

Fill in documentation for HashSet. #15772

merged 2 commits into from
Jul 19, 2014

Conversation

treeman
Copy link
Contributor

@treeman treeman commented Jul 18, 2014

Example how to use the set with a custom type. Fill in examples for the missing methods. Also group implemented traits below HashSet method impl.

Example how to use the set with a custom type. Fill in examples for the missing methods.
@alexcrichton
Copy link
Member

For other primitives we generally avoid filling in documentation for trait methods because the documentation is required to be on the trait definition instead. For example, the documentation of insert that you added forgets to mention what the returned bool represents.

We were also talking about the subject of imports in #15752 and #15762 and the verdict was that we shouldn't be hiding imports for now (for HashSet). They're pretty easy to scan over and also makes the examples more copy-pasteable.

@treeman
Copy link
Contributor Author

treeman commented Jul 18, 2014

I see, will fix.

bors added a commit that referenced this pull request Jul 19, 2014
Example how to use the set with a custom type. Fill in examples for the missing methods. Also group implemented traits below `HashSet` method impl.
@bors bors closed this Jul 19, 2014
@bors bors merged commit 01b6fd3 into rust-lang:master Jul 19, 2014
@treeman treeman deleted the hashset-doc branch July 20, 2014 11:37
bors added a commit to rust-lang-ci/rust that referenced this pull request Nov 27, 2023
fix: better resolve assoc item with type bound

Closes rust-lang#15772
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 this pull request may close these issues.

3 participants