Improve documentation for Iterator's methods #29311
Conversation
|
(rust_highfive has picked a reviewer for you, use r? to override) |
|
Hmm, the diff is too big to leave inline comments. |
|
@apasel422 oh no :( |
|
https://github.com/rust-lang/rust/pull/29311.patch is the raw diff, waiting to be opened in your favorite editor 😄 |
steveklabnik
force-pushed
the
doc_iterator_trait
branch
2 times, most recently
from
21d8795 to
59f9a56
Compare
|
Hm, @steveklabnik could you split up this commit perhaps for now to review? Without that there's basically no way to easily review this... |
steveklabnik
force-pushed
the
doc_iterator_trait
branch
from
59f9a56 to
0b8026f
Compare
|
@alexcrichton split it up into a bunch of smaller ones. github still shows it as one thing due to it all being in one file, it looks like :/ |
|
A common problem with most of the descriptions is use of word “closure” to mean “anything that satisfies That being said, I have no idea how to word it better so it is as concise and more correct. |
|
@nagisa yeah, it takes a closure, but you can convert a function pointer to a closure. |
steveklabnik
force-pushed
the
doc_iterator_trait
branch
2 times, most recently
from
59dada7 to
9331766
Compare
|
Okay, fixed up @nagisa 's issues, and re-broke them out. |
|
Oh, and this PR is part of #29360 |
|
Whew, awesome patch @steveklabnik! Just some minor nits here and there, but otherwise r=me with those addressed. |
steveklabnik
force-pushed
the
doc_iterator_trait
branch
from
9331766 to
7b30676
Compare
|
@bors: r=alexcrichton |
|
📌 Commit 7b30676 has been approved by |
steveklabnik
force-pushed
the
doc_iterator_trait
branch
from
7b30676 to
d91785a
Compare
This adds lots of examples, clarifies text, and just generally improves the documentation for Iterator.
|
@bors: r=alexcrichton (I forgot to re-run the tests since i modified some of them, whoops! all pass now) |
|
📌 Commit d91785a has been approved by |
This cleans up descriptions, adds more examples, and increases consistency between similar methods.
This cleans up descriptions, adds more examples, and increases
consistency between similar methods.