File tree Expand file tree Collapse file tree 1 file changed +2
-3
lines changed Expand file tree Collapse file tree 1 file changed +2
-3
lines changed Original file line number Diff line number Diff line change @@ -183,9 +183,8 @@ Book][unstable-masked] and [its tracking issue][issue-masked].
183
183
184
184
As designed in [ RFC 1990] , Rustdoc can read an external file to use as a type's documentation. This
185
185
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.
189
188
190
189
[ RFC 1990 ] : https://github.com/rust-lang/rfcs/pull/1990
191
190
You can’t perform that action at this time.
0 commit comments