Skip to content

make the safety documentation consistent in task::LocalWaker - #164213

Merged
rust-bors[bot] merged 1 commit into
rust-lang:mainfrom
yilin0518:fix_local_waker
Oct 17, 2026
Merged

make the safety documentation consistent in task::LocalWaker#164213
rust-bors[bot] merged 1 commit into
rust-lang:mainfrom
yilin0518:fix_local_waker

Conversation

@yilin0518

@yilin0518 yilin0518 commented Oct 12, 2026

Copy link
Copy Markdown
Contributor

This PR only contains a doc-only modification: To make the format of safety documentation consistent in taks::LocalWaker. As a member of safer-rust, we continue to improve the quality of safety doc in Rust std. We has a Rust goal to push us to work.

Thank you for your review and looking for your suggestion!

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

rustbot commented Oct 12, 2026

Copy link
Copy Markdown
Collaborator

r? @JohnTitor

rustbot has assigned @JohnTitor.
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 JohnTitor, Mark-Simulacrum

@rust-log-analyzer

This comment has been minimized.

Sign in to view
@yilin0518 yilin0518 mentioned this pull request Oct 13, 2026
Merged
JohnTitor
JohnTitor approved these changes Oct 16, 2026
View reviewed changes

@JohnTitor JohnTitor left a comment •
edited by rustbot
Loading

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@bors r+ rollup

View changes since this review

@rust-bors

rust-bors Bot commented Oct 16, 2026

Copy link
Copy Markdown
Contributor

📌 Commit ac009af has been approved by JohnTitor

It is now in the queue for this repository.

@rust-bors rust-bors Bot added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Oct 16, 2026
JonathanBrouwer added a commit to JonathanBrouwer/rust that referenced this pull request Oct 17, 2026
@JonathanBrouwer
Rollup merge of rust-lang#164213 - yilin0518:fix_local_waker, r=JohnT…
c36f6e7 
…itor

make the safety documentation consistent in task::LocalWaker

This PR only contains a doc-only modification: To make the format of safety documentation consistent in `taks::LocalWaker`. As a member of [safer-rust](https://github.com/safer-rust), we continue to improve the quality of safety doc in Rust std. We has a [Rust goal](rust-lang/goals#511) to push us to work.

Thank you for your review and looking for your suggestion!
@JonathanBrouwer JonathanBrouwer mentioned this pull request Oct 17, 2026
Closed
jhpratt added a commit to jhpratt/rust that referenced this pull request Oct 17, 2026
@jhpratt
Rollup merge of rust-lang#164213 - yilin0518:fix_local_waker, r=JohnT…
a3bd503 
…itor

make the safety documentation consistent in task::LocalWaker

This PR only contains a doc-only modification: To make the format of safety documentation consistent in `taks::LocalWaker`. As a member of [safer-rust](https://github.com/safer-rust), we continue to improve the quality of safety doc in Rust std. We has a [Rust goal](rust-lang/goals#511) to push us to work.

Thank you for your review and looking for your suggestion!
@jhpratt jhpratt mentioned this pull request Oct 17, 2026
Closed
rust-bors Bot pushed a commit that referenced this pull request Oct 17, 2026
@bors
Auto merge of #164456 - jhpratt:rollup-VUe9WNu, r=jhpratt
3b510ed 
Rollup of 10 pull requests

Successful merges:

 - #163731 (Add bootstrap step to build the TPDE plugin)
 - #160404 (fd-views: AsRef<File>&Co. for BorrowedFd)
 - #161698 (Fix rmeta-link metadata not being read on AIX)
 - #164016 (Tighten (absence of) return attribute checks in `some-abis-do-extend-params-to-32-bits.rs`)
 - #164424 (diagnostic: skip wrong loops when explaining borrow errors)
 - #162444 (Make `std::fs::{File, ReadDir, DirEntry}` always `needs_drop` even when unsupported.)
 - #163862 (Collect all limit attributes during TyCtxt creation)
 - #164213 (make the safety documentation consistent in task::LocalWaker)
 - #164356 (Add missing full stop)
 - #164374 (core: hint: fix `unlikely`'s example polarity typo)
jhpratt added a commit to jhpratt/rust that referenced this pull request Oct 17, 2026
@jhpratt
Rollup merge of rust-lang#164213 - yilin0518:fix_local_waker, r=JohnT…
fa11684 
…itor

make the safety documentation consistent in task::LocalWaker

This PR only contains a doc-only modification: To make the format of safety documentation consistent in `taks::LocalWaker`. As a member of [safer-rust](https://github.com/safer-rust), we continue to improve the quality of safety doc in Rust std. We has a [Rust goal](rust-lang/goals#511) to push us to work.

Thank you for your review and looking for your suggestion!
@jhpratt jhpratt mentioned this pull request Oct 17, 2026
Closed
rust-bors Bot pushed a commit that referenced this pull request Oct 17, 2026
@bors
Auto merge of #164460 - jhpratt:rollup-vcfZluk, r=jhpratt
aaf1db3 
Rollup of 10 pull requests

Successful merges:

 - #161698 (Fix rmeta-link metadata not being read on AIX)
 - #163373 (Canonicalize operands for commutative binary ops)
 - #164016 (Tighten (absence of) return attribute checks in `some-abis-do-extend-params-to-32-bits.rs`)
 - #164424 (diagnostic: skip wrong loops when explaining borrow errors)
 - #138744 (Add methods to TCP and UDP sockets to modify hop limit)
 - #162444 (Make `std::fs::{File, ReadDir, DirEntry}` always `needs_drop` even when unsupported.)
 - #163862 (Collect all limit attributes during TyCtxt creation)
 - #164213 (make the safety documentation consistent in task::LocalWaker)
 - #164356 (Add missing full stop)
 - #164374 (core: hint: fix `unlikely`'s example polarity typo)
rust-bors Bot pushed a commit that referenced this pull request Oct 17, 2026
@bors
Auto merge of #164460 - jhpratt:rollup-vcfZluk, r=jhpratt
bb1aa39 
Rollup of 10 pull requests

Successful merges:

 - #161698 (Fix rmeta-link metadata not being read on AIX)
 - #163373 (Canonicalize operands for commutative binary ops)
 - #164016 (Tighten (absence of) return attribute checks in `some-abis-do-extend-params-to-32-bits.rs`)
 - #164424 (diagnostic: skip wrong loops when explaining borrow errors)
 - #138744 (Add methods to TCP and UDP sockets to modify hop limit)
 - #162444 (Make `std::fs::{File, ReadDir, DirEntry}` always `needs_drop` even when unsupported.)
 - #163862 (Collect all limit attributes during TyCtxt creation)
 - #164213 (make the safety documentation consistent in task::LocalWaker)
 - #164356 (Add missing full stop)
 - #164374 (core: hint: fix `unlikely`'s example polarity typo)
JonathanBrouwer added a commit to JonathanBrouwer/rust that referenced this pull request Oct 17, 2026
@JonathanBrouwer
Rollup merge of rust-lang#164213 - yilin0518:fix_local_waker, r=JohnT…
2200cbe 
…itor

make the safety documentation consistent in task::LocalWaker

This PR only contains a doc-only modification: To make the format of safety documentation consistent in `taks::LocalWaker`. As a member of [safer-rust](https://github.com/safer-rust), we continue to improve the quality of safety doc in Rust std. We has a [Rust goal](rust-lang/goals#511) to push us to work.

Thank you for your review and looking for your suggestion!
This was referenced Oct 17, 2026
Closed
Merged
rust-bors Bot pushed a commit that referenced this pull request Oct 17, 2026
@bors
Auto merge of #164479 - JonathanBrouwer:rollup-0awAwS1, r=JonathanBro…
8006091 
…uwer

Rollup of 11 pull requests

Successful merges:

 - #162809 (Remap local def ids for deterministic metadata encoding)
 - #163373 (Canonicalize operands for commutative binary ops)
 - #164016 (Tighten (absence of) return attribute checks in `some-abis-do-extend-params-to-32-bits.rs`)
 - #164259 (std: make SOLID `sockaddr_storage` large enough for IPv6)
 - #164424 (diagnostic: skip wrong loops when explaining borrow errors)
 - #138744 (Add methods to TCP and UDP sockets to modify hop limit)
 - #162444 (Make `std::fs::{File, ReadDir, DirEntry}` always `needs_drop` even when unsupported.)
 - #163862 (Collect all limit attributes during TyCtxt creation)
 - #164213 (make the safety documentation consistent in task::LocalWaker)
 - #164356 (Add missing full stop)
 - #164374 (core: hint: fix `unlikely`'s example polarity typo)
@rust-bors
rust-bors Bot merged commit e0d877b into rust-lang:main Oct 17, 2026
14 checks passed
@rustbot rustbot added this to the 1.101.0 milestone Oct 17, 2026
rust-bors Bot pushed a commit that referenced this pull request Oct 17, 2026
@bors
Unrolled build for #164213 in rollup 164479
cee12f4 
Rollup merge of #164213 - yilin0518:fix_local_waker, r=JohnTitor

make the safety documentation consistent in task::LocalWaker

This PR only contains a doc-only modification: To make the format of safety documentation consistent in `taks::LocalWaker`. As a member of [safer-rust](https://github.com/safer-rust), we continue to improve the quality of safety doc in Rust std. We has a [Rust goal](rust-lang/goals#511) to push us to work.

Thank you for your review and looking for your suggestion!
@yilin0518 yilin0518 mentioned this pull request Oct 27, 2026
Merged
JonathanBrouwer added a commit to JonathanBrouwer/rust that referenced this pull request Oct 31, 2026
@JonathanBrouwer
Rollup merge of rust-lang#165019 - yilin0518:unify-unsafe-str, r=John…
2241dac 
…Titor

Add safety section for from_utf8_unchecked/from_raw_parts

This PR only contains doc changes and similar to rust-lang#164213, rust-lang#164241. This PR add `# Safety` section for `from_utf8_unchecked(mut)` and `from_raw_parts(mut)`. This can unify the safety doc in `str` thus all `pub unsafe fn` have `# Safety` section.

Thank you for your review.
JonathanBrouwer added a commit to JonathanBrouwer/rust that referenced this pull request Oct 31, 2026
@JonathanBrouwer
Rollup merge of rust-lang#165019 - yilin0518:unify-unsafe-str, r=John…
02ee21e 
…Titor

Add safety section for from_utf8_unchecked/from_raw_parts

This PR only contains doc changes and similar to rust-lang#164213, rust-lang#164241. This PR add `# Safety` section for `from_utf8_unchecked(mut)` and `from_raw_parts(mut)`. This can unify the safety doc in `str` thus all `pub unsafe fn` have `# Safety` section.

Thank you for your review.
rust-bors Bot pushed a commit that referenced this pull request Oct 31, 2026
@bors
Unrolled build for #165019 in rollup 165243
04b4371 
Rollup merge of #165019 - yilin0518:unify-unsafe-str, r=JohnTitor

Add safety section for from_utf8_unchecked/from_raw_parts

This PR only contains doc changes and similar to #164213, #164241. This PR add `# Safety` section for `from_utf8_unchecked(mut)` and `from_raw_parts(mut)`. This can unify the safety doc in `str` thus all `pub unsafe fn` have `# Safety` section.

Thank you for your review.
JonathanBrouwer added a commit to JonathanBrouwer/rust that referenced this pull request Nov 3, 2026
@JonathanBrouwer
Rollup merge of rust-lang#164241 - yilin0518:fix_ptr_unsafe, r=JohnTitor
bf6a207 
make the safety documentation consistent in Ptr module

This PR only contains doc changes. Similar to PR rust-lang#164213 , "make the safety documentation consistent in task::LocalWaker", the reason for this is that I found the current documentation has different representations. So I refactored this documentation in the `ptr` module and kept only the most commonly used pattern.
JonathanBrouwer added a commit to JonathanBrouwer/rust that referenced this pull request Nov 3, 2026
@JonathanBrouwer
Rollup merge of rust-lang#164241 - yilin0518:fix_ptr_unsafe, r=JohnTitor
b5eabe4 
make the safety documentation consistent in Ptr module

This PR only contains doc changes. Similar to PR rust-lang#164213 , "make the safety documentation consistent in task::LocalWaker", the reason for this is that I found the current documentation has different representations. So I refactored this documentation in the `ptr` module and kept only the most commonly used pattern.
JonathanBrouwer added a commit to JonathanBrouwer/rust that referenced this pull request Nov 3, 2026
@JonathanBrouwer
Rollup merge of rust-lang#164241 - yilin0518:fix_ptr_unsafe, r=JohnTitor
c271a91 
make the safety documentation consistent in Ptr module

This PR only contains doc changes. Similar to PR rust-lang#164213 , "make the safety documentation consistent in task::LocalWaker", the reason for this is that I found the current documentation has different representations. So I refactored this documentation in the `ptr` module and kept only the most commonly used pattern.
JonathanBrouwer added a commit to JonathanBrouwer/rust that referenced this pull request Nov 3, 2026
@JonathanBrouwer
Rollup merge of rust-lang#164241 - yilin0518:fix_ptr_unsafe, r=JohnTitor
1076a78 
make the safety documentation consistent in Ptr module

This PR only contains doc changes. Similar to PR rust-lang#164213 , "make the safety documentation consistent in task::LocalWaker", the reason for this is that I found the current documentation has different representations. So I refactored this documentation in the `ptr` module and kept only the most commonly used pattern.
JonathanBrouwer added a commit to JonathanBrouwer/rust that referenced this pull request Nov 3, 2026
@JonathanBrouwer
Rollup merge of rust-lang#164241 - yilin0518:fix_ptr_unsafe, r=JohnTitor
8ef7e1f 
make the safety documentation consistent in Ptr module

This PR only contains doc changes. Similar to PR rust-lang#164213 , "make the safety documentation consistent in task::LocalWaker", the reason for this is that I found the current documentation has different representations. So I refactored this documentation in the `ptr` module and kept only the most commonly used pattern.
JonathanBrouwer added a commit to JonathanBrouwer/rust that referenced this pull request Nov 3, 2026
@JonathanBrouwer
Rollup merge of rust-lang#164241 - yilin0518:fix_ptr_unsafe, r=JohnTitor
bc59e31 
make the safety documentation consistent in Ptr module

This PR only contains doc changes. Similar to PR rust-lang#164213 , "make the safety documentation consistent in task::LocalWaker", the reason for this is that I found the current documentation has different representations. So I refactored this documentation in the `ptr` module and kept only the most commonly used pattern.
rust-bors Bot pushed a commit that referenced this pull request Nov 4, 2026
@bors
Unrolled build for #164241 in rollup 165436
77106fe 
Rollup merge of #164241 - yilin0518:fix_ptr_unsafe, r=JohnTitor

make the safety documentation consistent in Ptr module

This PR only contains doc changes. Similar to PR #164213 , "make the safety documentation consistent in task::LocalWaker", the reason for this is that I found the current documentation has different representations. So I refactored this documentation in the `ptr` module and kept only the most commonly used pattern.
RalfJung pushed a commit to RalfJung/miri that referenced this pull request Nov 4, 2026
@JonathanBrouwer
Rollup merge of #164241 - yilin0518:fix_ptr_unsafe, r=JohnTitor
5a68c5c 
make the safety documentation consistent in Ptr module

This PR only contains doc changes. Similar to PR rust-lang/rust#164213 , "make the safety documentation consistent in task::LocalWaker", the reason for this is that I found the current documentation has different representations. So I refactored this documentation in the `ptr` module and kept only the most commonly used pattern.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@JohnTitor JohnTitor JohnTitor approved these changes

Assignees

@JohnTitor JohnTitor

Labels

S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-libs Relevant to the library team, which will review and decide on the PR/issue.

Projects

None yet

Milestone

1.101.0

Development

Successfully merging this pull request may close these issues.

4 participants

@yilin0518 @rustbot @rust-log-analyzer @JohnTitor