Skip to content
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

Add missing examples on Vec iter types #77017

Merged
merged 1 commit into from
Sep 24, 2020
Merged

Add missing examples on Vec iter types #77017

merged 1 commit into from
Sep 24, 2020

Conversation

GuillaumeGomez
Copy link
Member

@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Sep 21, 2020
jyn514
jyn514 reviewed Sep 22, 2020
View reviewed changes
library/alloc/src/vec.rs Outdated Show resolved Hide resolved
library/alloc/src/vec.rs Outdated Show resolved Hide resolved
library/alloc/src/vec.rs Outdated Show resolved Hide resolved
library/alloc/src/vec.rs Outdated Show resolved Hide resolved
@jyn514 jyn514 added A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools T-libs-api Relevant to the library API team, which will review and decide on the PR/issue. labels Sep 22, 2020
@pickfire
Copy link
Contributor

Wouldn't this duplicate the documentation on the original function? Now there are two examples, one in the function and one for the struct. I also recall there is another patch for this. IMHO not worth it since it may create redundancy in docs as the original function already contains example.

@GuillaumeGomez
Copy link
Member Author

@pickfire And like I said in the other PR, the examples here are focused on how to get this type, not how to use it (which is showed in the original function). All public items should have code examples.

@GuillaumeGomez GuillaumeGomez force-pushed the vec-missing-examples-iter branch from ff3e10f to 143557e Compare September 22, 2020 11:47
pickfire
pickfire reviewed Sep 23, 2020
View reviewed changes
Copy link
Contributor

@pickfire pickfire left a comment

Choose a reason for hiding this comment

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

Looks good to me.

pickfire
pickfire approved these changes Sep 23, 2020
View reviewed changes
Copy link
Contributor

@pickfire pickfire left a comment

Choose a reason for hiding this comment

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

Looks good to me.

@jyn514
Copy link
Member

jyn514 commented Sep 23, 2020

@bors r+ rollup

@bors
Copy link
Contributor

bors commented Sep 23, 2020

📌 Commit 143557e has been approved by jyn514

@bors bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Sep 23, 2020
@Dylan-DPC-zz
Copy link

@bors r+ rollup

@bors
Copy link
Contributor

bors commented Sep 23, 2020

💡 This pull request was already approved, no need to approve it again.

@bors
Copy link
Contributor

bors commented Sep 23, 2020

📌 Commit 143557e has been approved by Dylan-DPC

@Dylan-DPC-zz Dylan-DPC-zz mentioned this pull request Sep 23, 2020
Merged
bors added a commit to rust-lang-ci/rust that referenced this pull request Sep 23, 2020
@bors
Auto merge of rust-lang#77102 - Dylan-DPC:rollup-2jfrg3u, r=Dylan-DPC
c351775 
Rollup of 9 pull requests

Successful merges:

 - rust-lang#76898 (Record `tcx.def_span` instead of `item.span` in crate metadata)
 - rust-lang#76939 (emit errors during AbstractConst building)
 - rust-lang#76965 (Add cfg(target_has_atomic_equal_alignment) and use it for Atomic::from_mut.)
 - rust-lang#76993 (Changing the alloc() to accept &self instead of &mut self)
 - rust-lang#76994 (fix small typo in docs and comments)
 - rust-lang#77017 (Add missing examples on Vec iter types)
 - rust-lang#77042 (Improve documentation for ToSocketAddrs)
 - rust-lang#77047 (Miri: more informative deallocation error messages)
 - rust-lang#77055 (Add #[track_caller] to more panicking Cell functions)

Failed merges:

r? `@ghost`
@bors bors merged commit b763436 into rust-lang:master Sep 24, 2020
@rustbot rustbot added this to the 1.48.0 milestone Sep 24, 2020
@GuillaumeGomez GuillaumeGomez deleted the vec-missing-examples-iter branch September 24, 2020 08:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jyn514 jyn514 jyn514 left review comments

@Dylan-DPC-zz Dylan-DPC-zz Dylan-DPC-zz left review comments

@pickfire pickfire pickfire approved these changes

Assignees

@Dylan-DPC-zz Dylan-DPC-zz

Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-libs-api Relevant to the library API team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
1.48.0
Development

Successfully merging this pull request may close these issues.
7 participants
@GuillaumeGomez @pickfire @jyn514 @bors @Dylan-DPC-zz @rust-highfive @rustbot