Skip to content

improve documentation for Fn* traits#35810

Merged
bors merged 1 commit intorust-lang:masterfrom
matthew-piziak:fn-trait-example
Aug 30, 2016
Merged

improve documentation for Fn* traits#35810
bors merged 1 commit intorust-lang:masterfrom
matthew-piziak:fn-trait-example

Conversation

@matthew-piziak
Copy link
Contributor

@matthew-piziak matthew-piziak commented Aug 18, 2016

This PR is not yet a serious attempt at contribution. Rather, I'm opening this for discussion. I can think of a few things we may want to accomplish with the documentation of the Fn, FnMut, and FnOnce traits:

  • the relationship between these traits and the closures that implement them
  • examples of non-closure implementations
  • the relationship between these traits and Rust's ownership semantics

@rust-highfive
Copy link
Contributor

rust-highfive commented Aug 18, 2016

r? @alexcrichton

(rust_highfive has picked a reviewer for you, use r? to override)

@matthew-piziak
Copy link
Contributor Author

matthew-piziak commented Aug 18, 2016

@steveklabnik @GuillaumeGomez

gabomgp
gabomgp reviewed Aug 19, 2016
View reviewed changes
src/libcore/ops.rs Outdated
Copy link

@gabomgp gabomgp Aug 19, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you want to write "to take an mutable"

Copy link
Contributor Author

@matthew-piziak matthew-piziak Aug 19, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I do indeed. Thank you! I'll go ahead and refactor these docs a bit now.

@matthew-piziak
Copy link
Contributor Author

matthew-piziak commented Aug 19, 2016

I've added some more documentation, more for form then contact at this point because I don't quite understand these traits yet.

steveklabnik
steveklabnik reviewed Aug 19, 2016
View reviewed changes
src/libcore/ops.rs Outdated
Copy link
Contributor

@steveklabnik steveklabnik Aug 19, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

these should link to the traits

@matthew-piziak
Copy link
Contributor Author

matthew-piziak commented Aug 20, 2016

This is now approaching a serious attempt at contribution. :P

@GuillaumeGomez
Copy link
Member

GuillaumeGomez commented Aug 20, 2016

Nice! Seems good to me but I'll let @steveklabnik handles it.

@matthew-piziak
Copy link
Contributor Author

matthew-piziak commented Aug 20, 2016

Actually, I believe my FnOnce example is still incorrect because I can change the parameter bound to FnMut and it still works.

@matthew-piziak
Copy link
Contributor Author

matthew-piziak commented Aug 20, 2016

Okay, fixed.

@matthew-piziak
Copy link
Contributor Author

matthew-piziak commented Aug 20, 2016

r? @steveklabnik

@bors
Copy link
Collaborator

bors commented Aug 20, 2016

☔ The latest upstream changes (presumably #35857) made this pull request unmergeable. Please resolve the merge conflicts.

Mark-Simulacrum
Mark-Simulacrum reviewed Aug 21, 2016
View reviewed changes
src/libcore/ops.rs Outdated
Copy link
Member

@Mark-Simulacrum Mark-Simulacrum Aug 21, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps x * 2? I associate doubling with multiplication (though the two are clearly equivalent).

Copy link
Contributor Author

@matthew-piziak matthew-piziak Aug 21, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done. :)

@matthew-piziak
improve documentation for Fn* traits
67b9cd3 
I can think of a few things we may want to accomplish with the documentation of the `Fn`, `FnMut`, and `FnOnce` traits:
- the relationship between these traits and the closures that implement them
- examples of non-closure implementations
- the relationship between these traits and Rust's ownership semantics

add module-level documentation for `Fn*` traits

Describe how `Fn*` traits, closure types, and ownership semantics are
linked, and provide examples of higher-level functions that take `Fn*`s.

more examples for `Fn*` traits

create correct (though not yet elegant) examples for `FnMut` and `FnOnce`

add trait links to module-level documentation

third time's a charm!

argument -> capture for trait documentation

This wording will need to be supported with better examples for
capturing eventually.

correct `FnOnce` example

I also fixed some of the trait wording here to make the concept of
capturing clearer; though that still needs more work.

replace `x + x` with `x * 2` for `fn double`
@steveklabnik
Copy link
Contributor

steveklabnik commented Aug 25, 2016

@bors: r+ rollup

thanks a lot!

@bors
Copy link
Collaborator

bors commented Aug 25, 2016

📌 Commit 67b9cd3 has been approved by steveklabnik

@steveklabnik steveklabnik mentioned this pull request Aug 25, 2016
Closed
@steveklabnik steveklabnik mentioned this pull request Aug 26, 2016
Closed
@steveklabnik steveklabnik mentioned this pull request Aug 26, 2016
Closed
@Manishearth Manishearth mentioned this pull request Aug 27, 2016
Closed
@GuillaumeGomez GuillaumeGomez mentioned this pull request Aug 29, 2016
Closed
@bors
Copy link
Collaborator

bors commented Aug 29, 2016

⌛ Testing commit 67b9cd3 with merge 78f057b...

@bors
Copy link
Collaborator

bors commented Aug 29, 2016

💔 Test failed - auto-mac-64-opt-rustbuild

@arielb1
Copy link
Contributor

arielb1 commented Aug 29, 2016

@bors retry

bors added a commit that referenced this pull request Aug 29, 2016
@bors
Auto merge of #36090 - GuillaumeGomez:rollup, r=GuillaumeGomez
aee9774 
Rollup of 11 pull requests

- Successful merges: #35418, #35759, #35862, #35863, #35962, #35977, #35993, #35997, #36054, #36056, #36070
- Failed merges: #35771, #35810
@GuillaumeGomez GuillaumeGomez mentioned this pull request Aug 30, 2016
Merged
bors added a commit that referenced this pull request Aug 30, 2016
@bors
Auto merge of #36126 - GuillaumeGomez:rollup, r=GuillaumeGomez
badf406 
Rollup of 16 pull requests

- Successful merges: #35418, #35759, #35862, #35863, #35895, #35962, #35977, #35993, #35997, #36054, #36056, #36060, #36086, #36100, #36103, #36125
- Failed merges: #35771, #35810
GuillaumeGomez added a commit to GuillaumeGomez/rust that referenced this pull request Aug 30, 2016
@GuillaumeGomez
Rollup merge of rust-lang#35810 - matthew-piziak:fn-trait-example, r=…
aa3ee1d 
…steveklabnik

improve documentation for `Fn*` traits

This PR is not yet a serious attempt at contribution. Rather, I'm opening this for discussion. I can think of a few things we may want to accomplish with the documentation of the `Fn`, `FnMut`, and `FnOnce` traits:
- the relationship between these traits and the closures that implement them
- examples of non-closure implementations
- the relationship between these traits and Rust's ownership semantics
bors added a commit that referenced this pull request Aug 30, 2016
@bors
Auto merge of #36126 - GuillaumeGomez:rollup, r=GuillaumeGomez
4473130 
Rollup of 16 pull requests

- Successful merges: #35418, #35759, #35862, #35863, #35895, #35962, #35977, #35993, #35997, #36054, #36056, #36060, #36086, #36100, #36103, #36125
- Failed merges: #35771, #35810
@bors bors merged commit 67b9cd3 into rust-lang:master Aug 30, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

@steveklabnik steveklabnik

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

10 participants

@matthew-piziak @rust-highfive @GuillaumeGomez @bors @steveklabnik @arielb1 @durka @Mark-Simulacrum @gabomgp @alexcrichton