Skip to content

Fix doc comment of File::try_lock and File::try_lock_shared #145046

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

Merged
merged 1 commit into from
Aug 8, 2025

Conversation

ulrichstark
Copy link
Contributor

@ulrichstark ulrichstark commented Aug 7, 2025

The doc comments of functions File::try_lock and File::try_lock_shared stabilized today in version 1.89.0 document an incorrect type of Ok.

The result type was changed in #139343 after the latest change to the doc comments in #136876.

@rustbot
Copy link
Collaborator

rustbot commented Aug 7, 2025

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

@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 Aug 7, 2025
@rustbot

This comment has been minimized.

@ulrichstark
Copy link
Contributor Author

I just force pushed to remove description of commit message containing links.

@tgross35
Copy link
Contributor

tgross35 commented Aug 7, 2025

@bors r+ rollup

@bors
Copy link
Collaborator

bors commented Aug 7, 2025

📌 Commit 4888762 has been approved by tgross35

It is now in the queue for this repository.

@bors bors 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 Aug 7, 2025
tgross35 added a commit to tgross35/rust that referenced this pull request Aug 7, 2025
Fix doc comment of File::try_lock and File::try_lock_shared

The doc comments of functions `File::try_lock` and `File::try_lock_shared` stabilized today in version 1.89.0 document an incorrect type of `Ok`.

The result type was changed in rust-lang#139343 after the latest change to the doc comments in rust-lang#136876.
bors added a commit that referenced this pull request Aug 7, 2025
Rollup of 6 pull requests

Successful merges:

 - #144400 (`tests/ui/issues/`: The Issues Strike Back [3/N])
 - #144678 (Make no_mangle on foreign items explicit instead of implicit)
 - #145045 (doc(library): Fix Markdown in `Iterator::by_ref`)
 - #145046 (Fix doc comment of File::try_lock and File::try_lock_shared)
 - #145047 (move `type_check` out of `compute_regions`)
 - #145053 (Add a lot of NLL `known-bug` tests)

r? `@ghost`
`@rustbot` modify labels: rollup
tgross35 added a commit to tgross35/rust that referenced this pull request Aug 7, 2025
Fix doc comment of File::try_lock and File::try_lock_shared

The doc comments of functions `File::try_lock` and `File::try_lock_shared` stabilized today in version 1.89.0 document an incorrect type of `Ok`.

The result type was changed in rust-lang#139343 after the latest change to the doc comments in rust-lang#136876.
bors added a commit that referenced this pull request Aug 8, 2025
Rollup of 9 pull requests

Successful merges:

 - #144705 (compiler-builtins: plumb LSE support for aarch64 on linux/gnu when optimized-compiler-builtins not enabled)
 - #144857 (Port `#[allow_internal_unsafe]` to the new attribute system)
 - #144900 (Stabilize `unsigned_signed_diff` feature)
 - #144903 (Rename `begin_panic_handler` to `panic_handler`)
 - #144974 (compiler-builtins subtree update)
 - #145007 (Fix build/doc/test of error index generator)
 - #145018 (Derive `Hash` for rustc_public types)
 - #145045 (doc(library): Fix Markdown in `Iterator::by_ref`)
 - #145046 (Fix doc comment of File::try_lock and File::try_lock_shared)

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit 338a3e0 into rust-lang:master Aug 8, 2025
10 checks passed
rust-timer added a commit that referenced this pull request Aug 8, 2025
Rollup merge of #145046 - ulrichstark:master, r=tgross35

Fix doc comment of File::try_lock and File::try_lock_shared

The doc comments of functions `File::try_lock` and `File::try_lock_shared` stabilized today in version 1.89.0 document an incorrect type of `Ok`.

The result type was changed in #139343 after the latest change to the doc comments in #136876.
@rustbot rustbot added this to the 1.91.0 milestone Aug 8, 2025
github-actions bot pushed a commit to rust-lang/compiler-builtins that referenced this pull request Aug 9, 2025
Rollup of 9 pull requests

Successful merges:

 - rust-lang/rust#144705 (compiler-builtins: plumb LSE support for aarch64 on linux/gnu when optimized-compiler-builtins not enabled)
 - rust-lang/rust#144857 (Port `#[allow_internal_unsafe]` to the new attribute system)
 - rust-lang/rust#144900 (Stabilize `unsigned_signed_diff` feature)
 - rust-lang/rust#144903 (Rename `begin_panic_handler` to `panic_handler`)
 - rust-lang/rust#144974 (compiler-builtins subtree update)
 - rust-lang/rust#145007 (Fix build/doc/test of error index generator)
 - rust-lang/rust#145018 (Derive `Hash` for rustc_public types)
 - rust-lang/rust#145045 (doc(library): Fix Markdown in `Iterator::by_ref`)
 - rust-lang/rust#145046 (Fix doc comment of File::try_lock and File::try_lock_shared)

r? `@ghost`
`@rustbot` modify labels: rollup
github-actions bot pushed a commit to rust-lang/miri that referenced this pull request Aug 9, 2025
Rollup of 9 pull requests

Successful merges:

 - rust-lang/rust#144705 (compiler-builtins: plumb LSE support for aarch64 on linux/gnu when optimized-compiler-builtins not enabled)
 - rust-lang/rust#144857 (Port `#[allow_internal_unsafe]` to the new attribute system)
 - rust-lang/rust#144900 (Stabilize `unsigned_signed_diff` feature)
 - rust-lang/rust#144903 (Rename `begin_panic_handler` to `panic_handler`)
 - rust-lang/rust#144974 (compiler-builtins subtree update)
 - rust-lang/rust#145007 (Fix build/doc/test of error index generator)
 - rust-lang/rust#145018 (Derive `Hash` for rustc_public types)
 - rust-lang/rust#145045 (doc(library): Fix Markdown in `Iterator::by_ref`)
 - rust-lang/rust#145046 (Fix doc comment of File::try_lock and File::try_lock_shared)

r? `@ghost`
`@rustbot` modify labels: rollup
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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
Development

Successfully merging this pull request may close these issues.

5 participants