Skip to content

Remove confusing reference to “Immediate Undefined Behavior” from docs - #162458

Open
umanwizard wants to merge 1 commit into
rust-lang:mainfrom
umanwizard:patch-1
Open

umanwizard wants to merge 1 commit into
rust-lang:mainfrom
umanwizard:patch-1

Conversation

@umanwizard

Copy link
Copy Markdown
Contributor

The docs in core::ptr capitalize "Immediate Undefined Behavior" as if that were a technical term of art; it’s not. The code described just causes undefined behavior, not some special kind that is any more "Immediate" than usual.

The docs in core::ptr capitalize "Immediate Undefined Behavior" as if that were a technical term of art; it’s not. The code described just causes undefined behavior, not some special kind that is any more "Immediate" than usual.
@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 Sep 8, 2026
@rustbot

rustbot commented Sep 8, 2026

Copy link
Copy Markdown
Collaborator

r? @Mark-Simulacrum

rustbot has assigned @Mark-Simulacrum.
They will have a look at your PR within the next two weeks and either review your PR or reassign to another reviewer.

Use r? to explicitly pick a reviewer

Why was this reviewer chosen?

The reviewer was selected based on:

  • Owners of files modified in this PR: libs
  • libs expanded to 12 candidates
  • Random selection from Darksonn, JohnTitor, Mark-Simulacrum

@ChayimFriedman2

Copy link
Copy Markdown
Contributor

I think the "immediate" is important, as people sometimes tend to think it's only UB when they use the reference. I think if we won't capitalize it it will be all good.

@Mark-Simulacrum

Copy link
Copy Markdown
Member

r=me with a modification to drop the capitalization; there are several other cases of that formulation in the standard library.

@Mark-Simulacrum Mark-Simulacrum 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 Sep 19, 2026

This branch has not been deployed

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

Labels

S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. 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