Some improvements to the async docs #91192
Merged
+18
−8
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rust-highfive
added
the
S-waiting-on-review
This comment has been minimized.
This comment has been minimized.
GuillaumeGomez
requested changes
Nov 24, 2021
camelid
added
the
T-libs
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
|
Oh, on On a note, optimally it'd be nice if one could link to keywords simply by writing /// hello to [`if`], [`match`] and [`async`]
etc. |
|
To solve on |
|
@GuillaumeGomez oh ok I just thought allowing that only within the std might be nice because then this PR would have a few commits less. |
JohnCSimon
added
S-waiting-on-review
JohnCSimon
added
S-waiting-on-review
|
@rustbot ready |
GuillaumeGomez
approved these changes
Feb 20, 2022
|
Thanks! @bors: r+ rollup |
|
📌 Commit 297364e has been approved by |
bors
added
S-waiting-on-bors
matthiaskrgr
added a commit
to matthiaskrgr/rust
that referenced
this pull request
Feb 20, 2022
Some improvements to the async docs The goal here is to make the docs overall a little bit more comprehensive and add more links between the things. One thing that's not working yet is the links to the keywords. Somehow I couldn't get them to work. r? `@GuillaumeGomez` do you know how I could get the keyword links to work?
Manishearth
added a commit
to Manishearth/rust
that referenced
this pull request
Feb 20, 2022
Some improvements to the async docs The goal here is to make the docs overall a little bit more comprehensive and add more links between the things. One thing that's not working yet is the links to the keywords. Somehow I couldn't get them to work. r? ``@GuillaumeGomez`` do you know how I could get the keyword links to work?
Manishearth
added a commit
to Manishearth/rust
that referenced
this pull request
Feb 21, 2022
Some improvements to the async docs The goal here is to make the docs overall a little bit more comprehensive and add more links between the things. One thing that's not working yet is the links to the keywords. Somehow I couldn't get them to work. r? ```@GuillaumeGomez``` do you know how I could get the keyword links to work?
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Feb 21, 2022
…askrgr Rollup of 10 pull requests Successful merges: - rust-lang#91192 (Some improvements to the async docs) - rust-lang#94143 (rustc_const_eval: adopt let else in more places) - rust-lang#94156 (Gracefully handle non-UTF-8 string slices when pretty printing) - rust-lang#94186 (Update pin_static_ref stabilization version.) - rust-lang#94189 (Implement LowerHex on Scalar to clean up their display in rustdoc) - rust-lang#94190 (Use Metadata::modified instead of FileTime::from_last_modification_ti…) - rust-lang#94203 (CTFE engine: Scalar: expose size-generic to_(u)int methods) - rust-lang#94211 (Better error if the user tries to do assignment ... else) - rust-lang#94215 (trait system: comments and small nonfunctional changes) - rust-lang#94220 (Correctly handle miniz_oxide extern crate declaration) Failed merges: r? `@ghost` `@rustbot` modify labels: rollup
tmandry
reviewed
Apr 29, 2022
| @@ -5,7 +5,7 @@ use crate::ops; | |||
| use crate::pin::Pin; | |||
| use crate::task::{Context, Poll}; | |||
|
|
|||
| /// A future represents an asynchronous computation. | |||
| /// A future represents an asynchronous computation obtained by use of [`async`]. | |||
There was a problem hiding this comment.
This might be confusing; it isn't only obtained via async since Future is implemented manually for e.g. system resources. Most await chains bottom out in one of these manual implementations.
There was a problem hiding this comment.
Feel free to follow up with another PR.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The goal here is to make the docs overall a little bit more comprehensive and add more links between the things.
One thing that's not working yet is the links to the keywords. Somehow I couldn't get them to work.
r? @GuillaumeGomez do you know how I could get the keyword links to work?