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

Rephrase docs for Vec::drain to better clarify Drop behavior #39134

Closed
QuietMisdreavus opened this issue Jan 17, 2017 · 3 comments
Closed

Rephrase docs for Vec::drain to better clarify Drop behavior #39134

QuietMisdreavus opened this issue Jan 17, 2017 · 3 comments
Labels
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.

Comments

@QuietMisdreavus
Copy link
Member

(This is mostly for my own benefit as I've been separated from my Rust fork and associated development environment. If someone wants to pick this up, though, it's a wonderful first dive into documentation contributions! :3)

The "Note 1" on Vec::drain could be rephrased to be more clear. Something like "Note 1: The element range is removed even if the iterator is only partially consumed or not consumed at all." Some discussion in rust-beginners revealed some confusion around the current "is not consumed until the end" phrasing.
@steveklabnik steveklabnik added A-docs 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. labels Jan 17, 2017
@steveklabnik
Copy link
Member

I'm happy to mentor anyone who needs help submitting a PR for this!

@QuietMisdreavus QuietMisdreavus mentioned this issue Jan 17, 2017
Merged
@TheCycoONE
Copy link
Contributor

@steveklabnik That's appreciated!

@QuietMisdreavus
Copy link
Member Author

Closed by #39135.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
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.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@steveklabnik @TheCycoONE @QuietMisdreavus