]> git.lizzy.rs Git - rust.git/commitdiff
Adjust docs to new #[doc(include)] behaviour
authorJonas Schievink <jonasschievink@gmail.com>
Sun, 19 May 2019 11:33:16 +0000 (13:33 +0200)
committerJonas Schievink <jonasschievink@gmail.com>
Tue, 23 Jul 2019 15:17:31 +0000 (17:17 +0200)
src/doc/rustdoc/src/unstable-features.md

index 1d9510c9aacabcc9f4bd9940e712f8f105ac4510..6e32468b64dee0f4c4503f90e3424fd53dfdb61e 100644 (file)
@@ -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