-
Notifications
You must be signed in to change notification settings - Fork 13.3k
doc: remove over-explanation #29460
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
doc: remove over-explanation #29460
Conversation
(rust_highfive has picked a reviewer for you, use r? to override) |
@@ -2553,10 +2553,7 @@ pub trait Extend<A> { | |||
/// | |||
/// # Examples | |||
/// | |||
/// Basic usage: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is becoming more common throughout the standard library as I go through things, so it should stay.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Seems not needed since there is no "Advanced usage" example
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's about consistency.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would call it consistency if it was everywhere, but it isn't.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would also remove all those instances, unless they were accompanied with "Advanced usage" examples.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As I go through the docs, I'm adding them, so this will become gradually so over time.
☔ The latest upstream changes (presumably #29509) made this pull request unmergeable. Please resolve the merge conflicts. |
I think I'm 👎 on this PR overall. Extra explanation is good. Docs don't have to be terse. |
No description provided.