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

Improve docs for vec_extend_from_within #105030

Closed
wants to merge 1 commit into from
Closed

Improve docs for vec_extend_from_within #105030

wants to merge 1 commit into from

Conversation

HintringerFabian
Copy link
Contributor

Improves the documentation for the extends_from_within function for VEC
Fixes #104762

@rustbot
Copy link
Collaborator

rustbot commented Nov 28, 2022

r? @thomcc

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

@rustbot rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-libs Relevant to the library team, which will review and decide on the PR/issue. labels Nov 28, 2022
@rustbot
Copy link
Collaborator

rustbot commented Nov 28, 2022

Hey! It looks like you've submitted a new PR for the library teams!

If this PR contains changes to any rust-lang/rust public library APIs then please comment with @rustbot label +T-libs-api -T-libs to tag it appropriately. If this PR contains changes to any unstable APIs please edit the PR description to add a link to the relevant API Change Proposal or create one if you haven't already. If you're unsure where your change falls no worries, just leave it as is and the reviewer will take a look and make a decision to forward on if necessary.

Examples of T-libs-api changes:

  • Stabilizing library features
  • Introducing insta-stable changes such as new implementations of existing stable traits on existing stable types
  • Introducing new or changing existing unstable library APIs (excluding permanently unstable features / features without a tracking issue)
  • Changing public documentation in ways that create new stability guarantees
  • Changing observable runtime behavior of library APIs

@HintringerFabian HintringerFabian force-pushed the docs_Vec_extend_from_within branch from e5ddeeb to 14e0869 Compare November 28, 2022 21:24
@HintringerFabian HintringerFabian changed the title Docs vec extend from within Improve docs for vec_extend_from_within Nov 28, 2022
@HintringerFabian
Copy link
Contributor Author

@rustbot label +A-docs

@rustbot rustbot added the A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools label Nov 29, 2022
@thomcc
Copy link
Member

thomcc commented Dec 7, 2022

I think these your changes are well-motivated but probably need some rewording. I don't really feel like I'm the person to help figure that out though, so I'll reroll. Sorry for the delay.

r? libs

@rustbot rustbot assigned joshtriplett and unassigned thomcc Dec 7, 2022
compiler-errors
compiler-errors reviewed Dec 27, 2022
View reviewed changes
library/alloc/src/vec/mod.rs
@@ -2392,26 +2392,31 @@ impl<T: Clone, A: Allocator> Vec<T, A> {
self.spec_extend(other.iter())
}

/// Copies elements from `src` range to the end of the vector.
/// Appends elements specified by the `src` parameter to the end of the vector.
/// The `src` parameter is of type [`RangeBounds`], which means that
Copy link
Member

Choose a reason for hiding this comment

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

RangeBounds is a trait here, not a type. Not exactly sure what the best way to specify this is, though.

Copy link
Contributor

Choose a reason for hiding this comment

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

Since RangeBounds is in the signature anyway, and the examples show use of ranges, could this just be:

Copies elements from one part of the vector to the end.

src is the range that the elements will be copied from.

This would be consistent with the wording used in slice::copy_within

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

@compiler-errors compiler-errors compiler-errors left review comments

@clubby789 clubby789 clubby789 left review comments

Assignees

@joshtriplett joshtriplett

Labels
A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-libs Relevant to the library team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Confusing examples in Vec::extend_from_within
6 participants
@HintringerFabian @rustbot @thomcc @compiler-errors @clubby789 @joshtriplett