Skip to content

Commit 1cc7c21

Browse files
Adjust docs to new #[doc(include)] behaviour
1 parent 138e08c commit 1cc7c21

File tree

1 file changed

+2
-3
lines changed

1 file changed

+2
-3
lines changed

src/doc/rustdoc/src/unstable-features.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -183,9 +183,8 @@ Book][unstable-masked] and [its tracking issue][issue-masked].
183183

184184
As designed in [RFC 1990], Rustdoc can read an external file to use as a type's documentation. This
185185
is useful if certain documentation is so long that it would break the flow of reading the source.
186-
Instead of writing it all inline, writing `#[doc(include = "sometype.md")]` (where `sometype.md` is
187-
a file adjacent to the `lib.rs` for the crate) will ask Rustdoc to instead read that file and use it
188-
as if it were written inline.
186+
Instead of writing it all inline, writing `#[doc(include = "sometype.md")]` will ask Rustdoc to
187+
instead read that file and use it as if it were written inline.
189188

190189
[RFC 1990]: https://github.com/rust-lang/rfcs/pull/1990
191190

0 commit comments

Comments
 (0)