Skip to content
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

link to Future::poll from the Poll docs #129539

Merged
merged 1 commit into from
Aug 26, 2024
Merged

Conversation

oconnor663
Copy link
Contributor

The most important thing about Poll is that Future::poll returns it, but previously the docs didn't emphasize this.

@rustbot
Copy link
Collaborator

rustbot commented Aug 25, 2024

r? @cuviper

rustbot has assigned @cuviper.
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 25, 2024
The most important thing about Poll is that Future::poll returns it, but
previously the docs didn't emphasize this.
@oconnor663
Copy link
Contributor Author

Updated as suggested. Upon closer inspection, it looks like the other part of the same page that's using <code> tags is getting fancy with links within the code block:

image

@tgross35
Copy link
Contributor

Interesting, rustdoc does support generics like [`Poll<std::string::String>`]. 🤷

Thanks for this fixup!

r? @tgross35
@bors r+ rollup

@bors
Copy link
Contributor

bors commented Aug 25, 2024

📌 Commit 3153b7d has been approved by tgross35

It is now in the queue for this repository.

@rustbot rustbot assigned tgross35 and unassigned cuviper Aug 25, 2024
@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 25, 2024
bors added a commit to rust-lang-ci/rust that referenced this pull request Aug 26, 2024
…iaskrgr

Rollup of 7 pull requests

Successful merges:

 - rust-lang#129190 (Add f16 and f128 to tests/ui/consts/const-float-bits-conv.rs)
 - rust-lang#129377 (Add implementations for `unbounded_shl`/`unbounded_shr`)
 - rust-lang#129539 (link to Future::poll from the Poll docs)
 - rust-lang#129588 (pal/hermit: correctly round up microseconds in `Thread::sleep`)
 - rust-lang#129592 (Remove cfg(test) from library/core)
 - rust-lang#129597 (mv `build_reduced_graph_for_external_crate_res` into Resolver)
 - rust-lang#129600 (Tie `impl_trait_overcaptures` lint to Rust 2024)

r? `@ghost`
`@rustbot` modify labels: rollup
bors added a commit to rust-lang-ci/rust that referenced this pull request Aug 26, 2024
…iaskrgr

Rollup of 7 pull requests

Successful merges:

 - rust-lang#129190 (Add f16 and f128 to tests/ui/consts/const-float-bits-conv.rs)
 - rust-lang#129377 (Add implementations for `unbounded_shl`/`unbounded_shr`)
 - rust-lang#129539 (link to Future::poll from the Poll docs)
 - rust-lang#129588 (pal/hermit: correctly round up microseconds in `Thread::sleep`)
 - rust-lang#129592 (Remove cfg(test) from library/core)
 - rust-lang#129597 (mv `build_reduced_graph_for_external_crate_res` into Resolver)
 - rust-lang#129600 (Tie `impl_trait_overcaptures` lint to Rust 2024)

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit b1c9064 into rust-lang:master Aug 26, 2024
6 checks passed
@rustbot rustbot added this to the 1.82.0 milestone Aug 26, 2024
rust-timer added a commit to rust-lang-ci/rust that referenced this pull request Aug 26, 2024
Rollup merge of rust-lang#129539 - oconnor663:poll_link, r=tgross35

link to Future::poll from the Poll docs

The most important thing about Poll is that Future::poll returns it, but previously the docs didn't emphasize this.
@oconnor663 oconnor663 deleted the poll_link branch August 28, 2024 01:02
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.

None yet

5 participants