Update docs for impl keyword #136354
Merged
Update docs for impl keyword #136354
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
|
r? @ibraheemdev rustbot has assigned @ibraheemdev. Use |
rustbot
added
S-waiting-on-review
This comment has been minimized.
This comment has been minimized.
fmease
reviewed
Jan 31, 2025
library/std/src/keyword_docs.rs
Outdated
Comment on lines
654
to
655
| /// * An `impl` block is an item that is used to implement some functionality for a type. | ||
| /// * An `impl Trait` in a type-position can be used to designate a type that implements a trait called `Trait`. |
There was a problem hiding this comment.
Rustdoc tries its hardest to turn the first paragraph into a summary line that is used in the search results (and on module overview pages (not applicable here)).
In this case the list items are strung together without any separator (which looks like … type.An …). Arguably rustdoc could do better here and add an extra space.
Still, I think this should have a designated / proper summary line (for the search result page). Starting things off with a list instead of prose is generally slightly unusual independent of that I'd say.
There was a problem hiding this comment.
Good points. I've added back a summary line and an introduction for the list.
ibraheemdev
reviewed
Feb 11, 2025
|
r=me after the nit. |
ibraheemdev
added
S-waiting-on-author
|
Thanks. @bors r+ |
bors
added
S-waiting-on-bors
|
@bors rollup |
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Feb 11, 2025
…iaskrgr Rollup of 8 pull requests Successful merges: - rust-lang#135285 (it-self → itself, build-system → build system, type-alias → type alias) - rust-lang#135677 (Small `rustc_resolve` cleanups) - rust-lang#136239 (show supported register classes in error message) - rust-lang#136246 (include note on variance and example) - rust-lang#136354 (Update docs for impl keyword) - rust-lang#136786 (Remove the deduplicate_blocks pass) - rust-lang#136833 (compiler: die immediately instead of handling unknown target codegen) - rust-lang#136847 (Simplify intra-crate qualifiers.) r? `@ghost` `@rustbot` modify labels: rollup
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Feb 11, 2025
…iaskrgr Rollup of 8 pull requests Successful merges: - rust-lang#135285 (it-self → itself, build-system → build system, type-alias → type alias) - rust-lang#135677 (Small `rustc_resolve` cleanups) - rust-lang#136239 (show supported register classes in error message) - rust-lang#136246 (include note on variance and example) - rust-lang#136354 (Update docs for impl keyword) - rust-lang#136786 (Remove the deduplicate_blocks pass) - rust-lang#136833 (compiler: die immediately instead of handling unknown target codegen) - rust-lang#136847 (Simplify intra-crate qualifiers.) r? `@ghost` `@rustbot` modify labels: rollup
rust-timer
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Feb 12, 2025
Rollup merge of rust-lang#136354 - hkBst:patch-34, r=ibraheemdev Update docs for impl keyword This started as a fix for rust-lang#79878, but also introduces some structure (headings), and elaborates a tiny bit on impl Trait syntax.
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.
This started as a fix for #79878, but also introduces some structure (headings), and elaborates a tiny bit on impl Trait syntax.