Skip to content

Additional doc links and explanation of Wake. - #116387

Merged
bors merged 3 commits into
rust-lang:masterfrom
kpreid:wake-doc
Feb 14, 2024
Merged

Additional doc links and explanation of Wake.#116387
bors merged 3 commits into
rust-lang:masterfrom
kpreid:wake-doc

Conversation

@kpreid

Copy link
Copy Markdown
Contributor

This is intended to clarify:

  • That Wake exists and can be used instead of RawWaker.
  • How to construct a Waker when you are looking at Wake (which was previously only documented in the example).

@rustbot

Copy link
Copy Markdown
Collaborator

r? @scottmcm

(rustbot has picked a reviewer for you, use r? to override)

@rustbotrustbot 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 3, 2023
@scottmcm

Copy link
Copy Markdown
Member

I'm waker-ignorant, so re-rolling in hopes of getting someone more qualified:
r? libs

@rustbotrustbot assigned m-ou-se and unassigned scottmcmOct 3, 2023
@bors

bors commented Nov 6, 2023

Copy link
Copy Markdown
Collaborator

☔ The latest upstream changes (presumably #96979) made this pull request unmergeable. Please resolve the merge conflicts.

@rust-log-analyzer

This comment has been minimized.

@rust-log-analyzer

This comment has been minimized.

@kpreid

Copy link
Copy Markdown
ContributorAuthor

The broken link checker seems to be giving a false positive — the link works in generated docs.

@kpreid

Copy link
Copy Markdown
ContributorAuthor

Re-requesting review because of lack of response for 6 weeks.

r? libs

@rustbotrustbot assigned thomcc and unassigned m-ou-seNov 18, 2023
@thomcc

Copy link
Copy Markdown
Member

I'm going to be away for a few months, so I'm rerolling my PRs so that folks don't have to wait for me. Sorry/thanks.

r? libs

@rustbotrustbot assigned cuviper and unassigned thomccFeb 1, 2024
@cuviper

Copy link
Copy Markdown
Member

The addition looks fine to me, but the link checker is going to need to be fixed or otherwise convinced. Have you followed up on that at all?

This is intended to clarify:
* That `Wake` exists and can be used instead of `RawWaker`.
* How to construct a `Waker` when you are looking at `Wake`
(which was previously only documented in the example).
@kpreid

Copy link
Copy Markdown
ContributorAuthor

The addition looks fine to me, but the link checker is going to need to be fixed or otherwise convinced. Have you followed up on that at all?

To be honest, I was hoping someone would come along with “Oh, you just have to format it like so…”

To unblock this improvement to the docs, I've removed the link (except for a comment about why it doesn't exist).

@cuviper

Copy link
Copy Markdown
Member

@bors r+ rollup

@bors

bors commented Feb 14, 2024

Copy link
Copy Markdown
Collaborator

📌 Commit a6c91f0 has been approved by cuviper

It is now in the queue for this repository.

@borsbors 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 Feb 14, 2024
@oli-obkoli-obk mentioned this pull request Feb 14, 2024
bors added a commit to rust-lang-ci/rust that referenced this pull request Feb 14, 2024
Rollup of 13 pull requests
Successful merges:
- rust-lang#116387 (Additional doc links and explanation of `Wake`.)
- rust-lang#118738 (Netbsd10 update)
- rust-lang#118890 (Clarify the lifetimes of allocations returned by the `Allocator` trait)
- rust-lang#120498 (Uplift `TypeVisitableExt` into `rustc_type_ir`)
- rust-lang#120530 (Be less confident when `dyn` suggestion is not checked for object safety)
- rust-lang#120915 (Fix suggestion span for `?Sized` when param type has default)
- rust-lang#121015 (Optimize `delayed_bug` handling.)
- rust-lang#121024 (implement `Default` for `AsciiChar`)
- rust-lang#121039 (Correctly compute adjustment casts in GVN)
- rust-lang#121045 (Fix two UI tests with incorrect directive / invalid revision)
- rust-lang#121049 (Do not point at `#[allow(_)]` as the reason for compat lint triggering)
- rust-lang#121071 (Use fewer delayed bugs.)
- rust-lang#121073 (Fix typos in `OneLock` doc)
r? `@ghost`
`@rustbot` modify labels: rollup
@bors
bors merged commit 5d114f3 into rust-lang:masterFeb 14, 2024
@rustbotrustbot added this to the 1.78.0 milestone Feb 14, 2024
rust-timer added a commit to rust-lang-ci/rust that referenced this pull request Feb 14, 2024
Rollup merge of rust-lang#116387 - kpreid:wake-doc, r=cuviper
Additional doc links and explanation of `Wake`.
This is intended to clarify:
* That `Wake` exists and can be used instead of `RawWaker`.
* How to construct a `Waker` when you are looking at `Wake` (which was previously only documented in the example).
@kpreid
kpreid deleted the wake-doc branch February 15, 2024 03:08
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

S-waiting-on-borsStatus: Waiting on bors to run and complete tests. Bors will change the label on completion.T-libsRelevant 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.

8 participants

@kpreid@rustbot@scottmcm@bors@rust-log-analyzer@thomcc@cuviper@m-ou-se