-
Notifications
You must be signed in to change notification settings - Fork 933
Closed as duplicate of#5244
Labels
Description
When using a code block in a doc comment and wrap_comments
is enabled, the comment will wrap into the next line making the following code block no longer valid a valid code block.
The syntax reference for rustdoc says that exact syntax is the Fenced Code Blocks section of the CommonMark specification. The CommonMark spec states: "A fenced code block may interrupt a paragraph, and does not require a blank line either before or after."
Example
Initial code:
/// Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec a diam lectus. Sed sit amet ipsum mauris. Maecenas congue ligula ac quam
/// ```
/// let foo = 0;
/// ```
fn bar() {}
Result:
/// Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec a diam
/// lectus. Sed sit amet ipsum mauris. Maecenas congue ligula ac quam ```
/// let foo = 0;
/// ```
Expected:
/// Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec a diam
/// lectus. Sed sit amet ipsum mauris. Maecenas congue ligula ac quam
/// ```
/// let foo = 0;
/// ```