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.

Sign up for GitHub

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

Jump to bottom

Add Future trait for doc_spotlight feature doc #82396

Merged
merged 3 commits into from
Feb 27, 2021
Merged

Add Future trait for doc_spotlight feature doc #82396

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
888811b
Add Future trait for doc_spotlight feature doc
pickfire Feb 22, 2021
e56364f
Use Oxform comma
pickfire Feb 24, 2021
27f7a2e
Add for example word to spotlight doc
pickfire Feb 26, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/doc/unstable-book/src/language-features/doc-spotlight.md
View file
Open in desktop
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`, 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:

Expand Down