replace Add example with something more evocative of addition
#35709
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @alexcrichton (or someone else) soon. If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes. Please see the contribution instructions for more information. |
| @@ -166,25 +166,38 @@ macro_rules! forward_ref_binop { | |||
| /// | |||
| /// # Examples | |||
| /// | |||
| /// A trivial implementation of `Add`. When `Foo + Foo` happens, it ends up | |||
| /// calling `add`, and therefore, `main` prints `Adding!`. | |||
| /// This example creates a Point struct that implements Add, and then | |||
There was a problem hiding this comment.
Add "" aroundPointandAdd`.
|
Please squash your commits and it should be good to go. |
matthew-piziak
force-pushed
the
add-trait-example
branch
from
0807678
to
0f1eace
Compare
Currently most of the operator traits use trivial implementation examples that only perform side effects. Honestly, that might not be too bad for the sake of documentation; but anyway, here's a proposal to move a slightly modified version of the module-level point-addition example into the `Add` documentation, since it's more evocative of addition semantics. Part of rust-lang#29365 wrap identifiers in backticks minor rephrasing fix module-level documentation to be more truthful This branch changes the example for `Add` to no longer be a "minimum implementation that prints something to the screen".
matthew-piziak
force-pushed
the
add-trait-example
branch
from
1e83864
to
dcee93a
Compare
|
Thanks! @bors: r+ rollup |
|
📌 Commit dcee93a has been approved by |
matthew-piziak
added a commit
to matthew-piziak/rust
that referenced
this pull request
Aug 18, 2016
This is analogous to PR rust-lang#35709 for the `Add` trait.
steveklabnik
added a commit
to steveklabnik/rust
that referenced
this pull request
Aug 18, 2016
…=GuillaumeGomez replace `Add` example with something more evocative of addition Currently most of the operator traits use trivial implementation examples that only perform side effects. Honestly, that might not be too bad for the sake of documentation; but anyway, here's a proposal to move a slightly modified version of the module-level point-addition example into the `Add` documentation, since it's more evocative of addition semantics. Part of rust-lang#29365
steveklabnik
added a commit
to steveklabnik/rust
that referenced
this pull request
Aug 18, 2016
…=steveklabnik replace `AddAssign` example with something more evocative of addition This is analogous to PR rust-lang#35709 for the `Add` trait.
sophiajt
pushed a commit
to sophiajt/rust
that referenced
this pull request
Aug 19, 2016
…=GuillaumeGomez replace `Add` example with something more evocative of addition Currently most of the operator traits use trivial implementation examples that only perform side effects. Honestly, that might not be too bad for the sake of documentation; but anyway, here's a proposal to move a slightly modified version of the module-level point-addition example into the `Add` documentation, since it's more evocative of addition semantics. Part of rust-lang#29365
sophiajt
pushed a commit
to sophiajt/rust
that referenced
this pull request
Aug 19, 2016
…=steveklabnik replace `AddAssign` example with something more evocative of addition This is analogous to PR rust-lang#35709 for the `Add` trait.
sophiajt
pushed a commit
to sophiajt/rust
that referenced
this pull request
Aug 19, 2016
…=GuillaumeGomez replace `Add` example with something more evocative of addition Currently most of the operator traits use trivial implementation examples that only perform side effects. Honestly, that might not be too bad for the sake of documentation; but anyway, here's a proposal to move a slightly modified version of the module-level point-addition example into the `Add` documentation, since it's more evocative of addition semantics. Part of rust-lang#29365
sophiajt
pushed a commit
to sophiajt/rust
that referenced
this pull request
Aug 19, 2016
…=steveklabnik replace `AddAssign` example with something more evocative of addition This is analogous to PR rust-lang#35709 for the `Add` trait.
sophiajt
pushed a commit
to sophiajt/rust
that referenced
this pull request
Aug 20, 2016
…=GuillaumeGomez replace `Add` example with something more evocative of addition Currently most of the operator traits use trivial implementation examples that only perform side effects. Honestly, that might not be too bad for the sake of documentation; but anyway, here's a proposal to move a slightly modified version of the module-level point-addition example into the `Add` documentation, since it's more evocative of addition semantics. Part of rust-lang#29365
sophiajt
pushed a commit
to sophiajt/rust
that referenced
this pull request
Aug 20, 2016
…=steveklabnik replace `AddAssign` example with something more evocative of addition This is analogous to PR rust-lang#35709 for the `Add` trait.
sophiajt
pushed a commit
to sophiajt/rust
that referenced
this pull request
Aug 20, 2016
…=GuillaumeGomez replace `Add` example with something more evocative of addition Currently most of the operator traits use trivial implementation examples that only perform side effects. Honestly, that might not be too bad for the sake of documentation; but anyway, here's a proposal to move a slightly modified version of the module-level point-addition example into the `Add` documentation, since it's more evocative of addition semantics. Part of rust-lang#29365
sophiajt
pushed a commit
to sophiajt/rust
that referenced
this pull request
Aug 20, 2016
…=steveklabnik replace `AddAssign` example with something more evocative of addition This is analogous to PR rust-lang#35709 for the `Add` trait.
bors
added a commit
that referenced
this pull request
Aug 20, 2016
matthew-piziak
added a commit
to matthew-piziak/rust
that referenced
this pull request
Aug 22, 2016
These examples are exactly analogous to those in PRs rust-lang#35709 and rust-lang#35806. I'll probably remove the `fn main` wrappers for `Add` and `Sub` once this is merged in. Part of rust-lang#29365. r? @steveklabnik
sophiajt
pushed a commit
to sophiajt/rust
that referenced
this pull request
Aug 24, 2016
…laumeGomez more evocative examples for `Sub` and `SubAssign` These examples are exactly analogous to those in PRs rust-lang#35709 and rust-lang#35806. I'll probably remove the `fn main` wrappers for `Add` and `Sub` once this is merged in. Part of rust-lang#29365. r? @steveklabnik
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Currently most of the operator traits use trivial implementation
examples that only perform side effects. Honestly, that might not be too
bad for the sake of documentation; but anyway, here's a proposal to move
a slightly modified version of the module-level point-addition example
into the
Adddocumentation, since it's more evocative of additionsemantics.
Part of #29365