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

Fix typo in hint::black_box docs #109634

Closed
wants to merge 2 commits into from
Closed

Conversation

lilyyy411
Copy link
Contributor

situ, -> situations

@rustbot
Copy link
Collaborator

rustbot commented Mar 26, 2023

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @m-ou-se (or someone else) soon.

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 Mar 26, 2023
@rustbot
Copy link
Collaborator

rustbot commented Mar 26, 2023

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

@Dylan-DPC
Copy link
Member

Thanks for the contribution.
However, this looks like it isn't a typo:
»In situ« is a phrase which means »(situated)in the original place«

@danielhenrymantilla
Copy link
Contributor

danielhenrymantilla commented Mar 26, 2023

I do agree that in situ fits quite oddly here. I'd rather myself go with something along the lines of:

would actually be used, where ...

This seems to be, a priori, the intent the original author had (given the comma they wrote), and using in situ/"in the [very] place" is convoluted at best. By using "actually", it will be English rather than Latin, and in this case, simple English, which is a fortiori more accessible.

Ergo, removing that usage of in situ is an improvement, ceteris paribus 🙃: the author going and submitting a PR, motu propio, to discuss it, was thus the right move (although I agree with @Dylan-DPC that "situations where", although not wrong per se, is not what the original author intended).

@lilyyy411
Copy link
Contributor Author

I thought that this is what the original author intended but apparently I can't read

@m-ou-se m-ou-se added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels May 1, 2023
Co-authored-by: Chris Denton <christophersdenton@gmail.com>
Copy link
Contributor

@tgross35 tgross35 left a comment

Choose a reason for hiding this comment

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

I'm the one who originally wrote this and meant "in situ" as "in its natural place"/"in position", i.e., how you would come across this function when it's used in real code. But I see that apparently came off a bit abstract, so might as well KISS 🙂.

This definitely isn't a two commit kind of update though, so please squash and correct the commit message @4gboframram

@Dylan-DPC
Copy link
Member

There hasn't been much interest in this and I think the change doesn't clarify the wording more than the original. Closing this as it's been inactive for a while

@Dylan-DPC Dylan-DPC closed this Aug 8, 2023
@Dylan-DPC Dylan-DPC added S-inactive Status: Inactive and waiting on the author. This is often applied to closed PRs. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Aug 8, 2023
tmandry added a commit to tmandry/rust that referenced this pull request Oct 2, 2023
Improve wording of `hint::black_box` docs

The wording is a bit confusing.

squash of rust-lang#109634
rust-timer added a commit to rust-lang-ci/rust that referenced this pull request Oct 2, 2023
Rollup merge of rust-lang#116350 - Nilstrieb:in-situ, r=Dylan-DPC

Improve wording of `hint::black_box` docs

The wording is a bit confusing.

squash of rust-lang#109634
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-inactive Status: Inactive and waiting on the author. This is often applied to closed PRs. 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.

7 participants