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.

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

improve Vec::extends_from_within docs #104777

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 23, 2022

r? @joshtriplett

(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 23, 2022
@rustbot
Copy link
Collaborator

rustbot commented Nov 23, 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 f6b10d0 to c18461d Compare November 23, 2022 15:07
Comment on lines 2408 to 2421
/// With numbers:
///
/// ```
/// let mut vec = vec![0, 1, 2, 3, 4];
/// let mut numbers1 = vec![0, 1, 2, 3, 4];
/// numbers1.extend_from_within(2..);
/// assert_eq!(numbers1, [0, 1, 2, 3, 4, 2, 3, 4]);
///
/// let mut numbers2 = vec![0, 1, 2, 3, 4];
/// numbers2.extend_from_within(..2);
/// assert_eq!(numbers2, [0, 1, 2, 3, 4, 0, 1]);
///
/// vec.extend_from_within(2..);
/// assert_eq!(vec, [0, 1, 2, 3, 4, 2, 3, 4]);
/// let mut numbers3 = vec![0, 1, 2, 3, 4];
/// numbers3.extend_from_within(1..3);
/// assert_eq!(numbers3, [0, 1, 2, 3, 4, 1, 2]);
Copy link
Member

@the8472 the8472 Nov 23, 2022

Choose a reason for hiding this comment

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

If the goal is to prevent confusion between the indices and values then this section can just be replaced, no need to keep it.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done thx

@HintringerFabian
Copy link
Contributor Author

r? @scottmcm

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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
Development

Successfully merging this pull request may close these issues.

Confusing examples in Vec::extend_from_within
5 participants