Skip to content

Add missing examples on Vec iter types - #77017

Merged
bors merged 1 commit into
rust-lang:masterfrom
GuillaumeGomez:vec-missing-examples-iter
Sep 24, 2020
Merged

Add missing examples on Vec iter types#77017
bors merged 1 commit into
rust-lang:masterfrom
GuillaumeGomez:vec-missing-examples-iter

Conversation

@GuillaumeGomez

@GuillaumeGomezGuillaumeGomez commented Sep 21, 2020

Copy link
Copy Markdown
Member

@rust-highfiverust-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
Comment threadlibrary/alloc/src/vec.rs Outdated
Comment threadlibrary/alloc/src/vec.rs Outdated
Comment threadlibrary/alloc/src/vec.rs Outdated
Comment threadlibrary/alloc/src/vec.rs Outdated
@jyn514jyn514 added A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools T-libs-api [DEPRECATED; DO NOT USE] labels Sep 22, 2020
@pickfire

pickfire commented Sep 22, 2020

Copy link
Copy Markdown
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

GuillaumeGomez commented Sep 22, 2020

Copy link
Copy Markdown
MemberAuthor

@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.

pickfire
pickfire reviewed Sep 23, 2020
View reviewed changes

@pickfirepickfire left a comment

Copy link
Copy Markdown
Contributor

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

@pickfirepickfire left a comment

Copy link
Copy Markdown
Contributor

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

jyn514 commented Sep 23, 2020

Copy link
Copy Markdown
Member

@bors r+ rollup

@bors

bors commented Sep 23, 2020

Copy link
Copy Markdown
Collaborator

📌 Commit 143557e has been approved by jyn514

@borsbors 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

Dylan-DPC-zz commented Sep 23, 2020

Copy link
Copy Markdown

@bors r+ rollup

@bors

bors commented Sep 23, 2020

Copy link
Copy Markdown
Collaborator

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

@bors

bors commented Sep 23, 2020

Copy link
Copy Markdown
Collaborator

📌 Commit 143557e has been approved by Dylan-DPC

@Dylan-DPC-zzDylan-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 ofrust-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:masterSep 24, 2020
@rustbotrustbot 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 freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

3 more reviewers
@Dylan-DPC-zzDylan-DPC-zzDylan-DPC-zz left review comments
@jyn514jyn514jyn514 left review comments
@pickfirepickfirepickfire approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

@Dylan-DPC-zzDylan-DPC-zz

Labels

A-docsArea: Documentation for any part of the project, including the compiler, standard library, and toolsS-waiting-on-borsStatus: Waiting on bors to run and complete tests. Bors will change the label on completion.T-libs-api[DEPRECATED; DO NOT USE]

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