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

Improve option API docs #40999

Merged

bors merged 4 commits into rust-lang:master from irfanhudda:improve-option-docs

Apr 5, 2017

Contributor

irfanhudda commented Apr 1, 2017

Associated Issue: #29366

Improve option API docs for

IntoIter struct
Iter struct
IterMut struct

r? @steveklabnik

irfanhudda added 3 commits

April 1, 2017 21:58


          Improve docs of core::option::IntoIter

128a313


          Improve docs of core::option::IterMut

029ace4


          Improve docs of core::option::Iter

c414628

rust-highfive assigned steveklabnik

Collaborator

rust-highfive commented Apr 1, 2017

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @steveklabnik (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.

steveklabnik suggested changes

View reviewed changes

Member

steveklabnik left a comment

some nits!

src/libcore/option.rs Outdated

+              ///
+              /// The iterator yields one value if the [`Option`] is a [`Some`] variant, otherwise none.
+              ///
+              /// This `struct` is created by [`Option::iter`] function.

Member

steveklabnik Apr 1, 2017

"by the", please :)

src/libcore/option.rs Outdated

-              /// An iterator over a reference of the contained item in an [`Option`].
+              /// An iterator over a reference to the [`Some`] variant of an [`Option`].
+              ///
+              /// The iterator yields one value if the [`Option`] is a [`Some`] variant, otherwise none.

Member

steveklabnik Apr 1, 2017

can you remove "variant" here, it sounds more natural without it to me.

src/libcore/option.rs Outdated

+              ///
+              /// The iterator yields one value if the [`Option`] is a [`Some`] variant, otherwise none.
+              ///
+              /// This `struct` is created by [`Option::iter_mut`] function.

Member

steveklabnik Apr 1, 2017

same two comments here

src/libcore/option.rs Outdated

+              ///
+              /// The iterator yields one value if the [`Option`] is a [`Some`] variant, otherwise none.
+              ///
+              /// This `struct` is created by [`Option::into_iter`] function.

Member

steveklabnik Apr 1, 2017

and here

frewsxcv added the A-docs label


          Minor changes to core::option docs

4c9f8ae

Contributor Author

irfanhudda commented Apr 2, 2017

@steveklabnik Thanks for the review. I've made some changes here.

steveklabnik approved these changes

View reviewed changes

Member

steveklabnik commented Apr 2, 2017

@bors: r+ rollup

thank you!

Contributor

bors commented Apr 2, 2017

📌 Commit 4c9f8ae has been approved by steveklabnik

frewsxcv added a commit to frewsxcv/rust that referenced this pull request


          Rollup merge of rust-lang#40999 - irfanhudda:improve-option-docs, r=s…

7a86857

…teveklabnik

Improve option API docs

Associated Issue: rust-lang#29366

Improve `option` API docs for
* `IntoIter` struct
* `Iter` struct
* `IterMut` struct

r? @steveklabnik

frewsxcv mentioned this pull request

Rollup of 9 pull requests #41034

Closed

frewsxcv added a commit to frewsxcv/rust that referenced this pull request


          Rollup merge of rust-lang#40999 - irfanhudda:improve-option-docs, r=s…

ec8f1df

…teveklabnik

Improve option API docs

Associated Issue: rust-lang#29366

Improve `option` API docs for
* `IntoIter` struct
* `Iter` struct
* `IterMut` struct

r? @steveklabnik

frewsxcv mentioned this pull request

Rollup of 13 pull requests #41040

Closed

frewsxcv added a commit to frewsxcv/rust that referenced this pull request


          Rollup merge of rust-lang#40999 - irfanhudda:improve-option-docs, r=s…

…teveklabnik

Improve option API docs

Associated Issue: rust-lang#29366

Improve `option` API docs for
* `IntoIter` struct
* `Iter` struct
* `IterMut` struct

r? @steveklabnik

frewsxcv mentioned this pull request

Rollup of 12 pull requests #41041

Closed

frewsxcv added a commit to frewsxcv/rust that referenced this pull request


          Rollup merge of rust-lang#40999 - irfanhudda:improve-option-docs, r=s…

db6b4e7

…teveklabnik

Improve option API docs

Associated Issue: rust-lang#29366

Improve `option` API docs for
* `IntoIter` struct
* `Iter` struct
* `IterMut` struct

r? @steveklabnik

frewsxcv mentioned this pull request

Rollup of 18 pull requests #41067

Closed

frewsxcv added a commit to frewsxcv/rust that referenced this pull request


          Rollup merge of rust-lang#40999 - irfanhudda:improve-option-docs, r=s…

64443c8

…teveklabnik

Improve option API docs

Associated Issue: rust-lang#29366

Improve `option` API docs for
* `IntoIter` struct
* `Iter` struct
* `IterMut` struct

r? @steveklabnik

frewsxcv mentioned this pull request

Rollup of 17 pull requests #41068

Closed

frewsxcv mentioned this pull request

Rollup of 16 pull requests #41070

Closed

frewsxcv added a commit to frewsxcv/rust that referenced this pull request


          Rollup merge of rust-lang#40999 - irfanhudda:improve-option-docs, r=s…

854c81c

…teveklabnik

Improve option API docs

Associated Issue: rust-lang#29366

Improve `option` API docs for
* `IntoIter` struct
* `Iter` struct
* `IterMut` struct

r? @steveklabnik

frewsxcv added a commit to frewsxcv/rust that referenced this pull request


          Rollup merge of rust-lang#40999 - irfanhudda:improve-option-docs, r=s…

4ed4c41

…teveklabnik

Improve option API docs

Associated Issue: rust-lang#29366

Improve `option` API docs for
* `IntoIter` struct
* `Iter` struct
* `IterMut` struct

r? @steveklabnik

frewsxcv mentioned this pull request

Rollup of 19 pull requests #41086

Merged

bors added a commit that referenced this pull request


          Auto merge of #41086 - frewsxcv:rollup, r=frewsxcv

46f71a0

Rollup of 19 pull requests

- Successful merges: #40608, #40870, #40949, #40977, #40981, #40988, #40992, #40997, #40999, #41007, #41014, #41019, #41035, #41043, #41049, #41062, #41066, #41076, #41085
- Failed merges:

bors merged commit 4c9f8ae into rust-lang:master

chordowl mentioned this pull request

API Docs: option #29366

Closed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment