diff options
| author | Jonas Schievink <jonasschievink@gmail.com> | 2019-05-19 13:33:16 +0200 |
|---|---|---|
| committer | Jonas Schievink <jonasschievink@gmail.com> | 2019-07-23 17:17:31 +0200 |
| commit | 1cc7c211f5ff566f0ea2270197a15d1ab8c429bf (patch) | |
| tree | 1c3df5ea57fff08a08fb25f6790063a5e4f5c863 /src | |
| parent | 138e08ccf6f6c6caf55a135bd0edcba8e6855df5 (diff) | |
| download | rust-1cc7c211f5ff566f0ea2270197a15d1ab8c429bf.tar.gz rust-1cc7c211f5ff566f0ea2270197a15d1ab8c429bf.zip | |
Adjust docs to new #[doc(include)] behaviour
Diffstat (limited to 'src')
| -rw-r--r-- | src/doc/rustdoc/src/unstable-features.md | 5 |
1 files changed, 2 insertions, 3 deletions
diff --git a/src/doc/rustdoc/src/unstable-features.md b/src/doc/rustdoc/src/unstable-features.md index 1d9510c9aac..6e32468b64d 100644 --- a/src/doc/rustdoc/src/unstable-features.md +++ b/src/doc/rustdoc/src/unstable-features.md @@ -183,9 +183,8 @@ Book][unstable-masked] and [its tracking issue][issue-masked]. As designed in [RFC 1990], Rustdoc can read an external file to use as a type's documentation. This is useful if certain documentation is so long that it would break the flow of reading the source. -Instead of writing it all inline, writing `#[doc(include = "sometype.md")]` (where `sometype.md` is -a file adjacent to the `lib.rs` for the crate) will ask Rustdoc to instead read that file and use it -as if it were written inline. +Instead of writing it all inline, writing `#[doc(include = "sometype.md")]` will ask Rustdoc to +instead read that file and use it as if it were written inline. [RFC 1990]: https://github.com/rust-lang/rfcs/pull/1990 |