diff options
| author | Dylan DPC <dylan.dpc@gmail.com> | 2021-02-27 02:34:24 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-02-27 02:34:24 +0100 |
| commit | 9f95666883a7b063c2b210c5636ec46ec50b8c1b (patch) | |
| tree | 1827980dfbb96acb92cd7d8df0978fd8811274b0 | |
| parent | b89357b409c314f58222a5045e4f9016742964f8 (diff) | |
| parent | 27f7a2e18d456a161382f51a1db6402b36ca0b24 (diff) | |
| download | rust-9f95666883a7b063c2b210c5636ec46ec50b8c1b.tar.gz rust-9f95666883a7b063c2b210c5636ec46ec50b8c1b.zip | |
Rollup merge of #82396 - pickfire:patch-5, r=GuillaumeGomez
Add Future trait for doc_spotlight feature doc
| -rw-r--r-- | src/doc/unstable-book/src/language-features/doc-spotlight.md | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/src/doc/unstable-book/src/language-features/doc-spotlight.md b/src/doc/unstable-book/src/language-features/doc-spotlight.md index 8117755fef1..75eff163318 100644 --- a/src/doc/unstable-book/src/language-features/doc-spotlight.md +++ b/src/doc/unstable-book/src/language-features/doc-spotlight.md @@ -5,8 +5,8 @@ The tracking issue for this feature is: [#45040] The `doc_spotlight` feature allows the use of the `spotlight` parameter to the `#[doc]` attribute, to "spotlight" a specific trait on the return values of functions. Adding a `#[doc(spotlight)]` attribute to a trait definition will make rustdoc print extra information for functions which return -a type that implements that trait. This attribute is applied to the `Iterator`, `io::Read`, and -`io::Write` traits in the standard library. +a type that implements that trait. For example, this attribute is applied to the `Iterator`, +`io::Read`, `io::Write`, and `Future` traits in the standard library. You can do this on your own traits, like this: |