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 select_nth_unstable documentation clarity #134976

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

mgsloan
Copy link
Contributor

@mgsloan mgsloan commented Dec 31, 2024

  • Instead uses before and after variable names in the example
    where greater and lesser are flipped.

  • Uses <= and >= instead of "less than or equal to" and "greater
    than or equal to" to make the docs more concise.

  • General attempt to remove unnecessary words and be more precise. For
    example it seems slightly wrong to say "its final sorted position",
    since this implies there is only one sorted position for this element.

@rustbot
Copy link
Collaborator

rustbot commented Dec 31, 2024

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @ibraheemdev (or someone else) some time within the next two weeks.

Please see the contribution instructions for more information. Namely, in order to ensure the minimum review times lag, PR authors and assigned reviewers should ensure that the review label (S-waiting-on-review and S-waiting-on-author) stays updated, invoking these commands when appropriate:

  • @rustbot author: the review is finished, PR author should check the comments and take action accordingly
  • @rustbot review: the author is ready for a review, this PR will be queued again in the reviewer's queue

@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 Dec 31, 2024
@rust-log-analyzer

This comment has been minimized.

* Instead uses `before` and `after` variable names in the example
where `greater` and `lesser` are flipped.

* Uses `<=` and `>=` instead of "less than or equal to" and "greater
than or equal to" to make the docs more concise.

* General attempt to remove unnecessary words and be more precise. For
example it seems slightly wrong to say "its final sorted position",
since this implies there is only one sorted position for this element.
@mgsloan mgsloan force-pushed the improve-select-nth-unstable-docs branch from dc9e804 to 217e10a Compare December 31, 2024 22:59
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.

4 participants