Skip to content

Slightly improve docs of intrinsics - #166296

Open
BioTomateDE wants to merge 1 commit into
rust-lang:mainfrom
BioTomateDE:intrinsics-doc
Open

BioTomateDE wants to merge 1 commit into
rust-lang:mainfrom
BioTomateDE:intrinsics-doc

Conversation

@BioTomateDE

Copy link
Copy Markdown
  • Normalized docstrings to be have a period at the end of the sentence and use the -s form of the verb.

  • Fixed typo Ise instead of Use in comment.

  • Added newlines between intrinsic definitions.

  • Replaced "This intrinsic does not have a stable counterpart." with "The to-be-stabilized version of this intrinsic is [...]." for likely and unlikely.

  • Also added the text in the parens for const_allocate docs:

    At runtime, just returns a null pointer (typical return value for failed allocations).

    This change might be slightly controversial, feel free to remove it if you want.

Note: PR split from #166295

@rustbot

rustbot commented Nov 21, 2026

Copy link
Copy Markdown
Collaborator

Some changes occurred to the intrinsics. Make sure the CTFE / Miri interpreter
gets adapted for the changes, if necessary.

cc @rust-lang/miri, @RalfJung, @oli-obk, @lcnr

@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 21, 2026
@rustbot

rustbot commented Nov 21, 2026

Copy link
Copy Markdown
Collaborator

Thanks for the pull request, and welcome! The Rust Project has assigned @Mark-Simulacrum (or someone else) to review your changes, you should hear from them (or someone else) within the next two weeks.

Please see the contribution instructions and our LLM policy for more information.

Why was this reviewer chosen?

The reviewer was selected based on:

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

@thomcc

thomcc commented Nov 21, 2026

Copy link
Copy Markdown
Member

r? @thomcc

@rustbot rustbot assigned thomcc and unassigned Mark-Simulacrum Nov 21, 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-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