Closed
Description
Putting code at the top of a docstring results in the entire code bit being included in the short summary of the docstring.
The following code
/// ```
/// foo
/// bar
/// ```
pub struct Foo;Results in the following foo/index.html page
Having large code samples there generates ugly documentation. For instance, I ran across the following while working through #54824 (in src/test/rustdoc/issue-47183.rs)
Which is generated by the following code:
/// ```no_run
/// # # space
/// # comment
/// ## single
/// ### double
/// #### triple
/// ##[outer]
/// ##![inner]
/// ```
pub struct Foo;
My suggestion would be that rustdoc should detect whether the first line of a doc comment is the beginning of a code block, and if so, it should leave it out of the "preview".