Skip to content

Commit

Permalink
Add for example word to spotlight doc
Browse files Browse the repository at this point in the history
As suggested by GuillaumeGomez
  • Loading branch information
pickfire authored Feb 26, 2021
1 parent e56364f commit 27f7a2e
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions src/doc/unstable-book/src/language-features/doc-spotlight.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`,
`io::Write`, and `Future` 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:

Expand Down

0 comments on commit 27f7a2e

Please sign in to comment.