You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: Configurations.md
+45
Original file line number
Diff line number
Diff line change
@@ -3074,6 +3074,51 @@ See also [`brace_style`](#brace_style), [`control_brace_style`](#control_brace_s
3074
3074
3075
3075
Break comments to fit on the line
3076
3076
3077
+
Note that no wrapping will happen if:
3078
+
1. An URL was found in the comment
3079
+
3080
+
-**Default value**: `false`
3081
+
-**Possible values**: `true`, `false`
3082
+
-**Stable**: No (tracking issue: [#3347](https://github.com/rust-lang/rustfmt/issues/3347))
3083
+
3084
+
#### `false` (default):
3085
+
3086
+
```rust
3087
+
// Lorem ipsum dolor sit amet, consectetur adipiscing elit,
3088
+
// sed do eiusmod tempor incididunt ut labore et dolore
3089
+
// magna aliqua. Ut enim ad minim veniam, quis nostrud
3090
+
// exercitation ullamco laboris nisi ut aliquip ex ea
3091
+
// commodo consequat.
3092
+
3093
+
// Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
3094
+
3095
+
// Information on the lorem ipsum can be found at the following url: https://en.wikipedia.org/wiki/Lorem_ipsum. Its text is: lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
3096
+
structFoo {}
3097
+
```
3098
+
3099
+
#### `true`:
3100
+
3101
+
```rust
3102
+
// Lorem ipsum dolor sit amet, consectetur adipiscing elit,
3103
+
// sed do eiusmod tempor incididunt ut labore et dolore
3104
+
// magna aliqua. Ut enim ad minim veniam, quis nostrud
3105
+
// exercitation ullamco laboris nisi ut aliquip ex ea
3106
+
// commodo consequat.
3107
+
3108
+
// Lorem ipsum dolor sit amet, consectetur adipiscing elit,
3109
+
// sed do eiusmod tempor incididunt ut labore et dolore
3110
+
// magna aliqua. Ut enim ad minim veniam, quis nostrud
3111
+
// exercitation ullamco laboris nisi ut aliquip ex ea
3112
+
// commodo consequat.
3113
+
3114
+
// Information on the lorem ipsum can be found at the following url: https://en.wikipedia.org/wiki/Lorem_ipsum. Its text is: lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
3115
+
structFoo {}
3116
+
```
3117
+
3118
+
## `wrap_doc_comments`
3119
+
3120
+
Break comments to fit on the line
3121
+
3077
3122
Note that no wrapping will happen if:
3078
3123
1. The comment is the start of a markdown header doc comment
Copy file name to clipboardExpand all lines: tests/source/configs/wrap_comments/true.rs
+2
Original file line number
Diff line number
Diff line change
@@ -3,6 +3,8 @@
3
3
// Wrap comments
4
4
5
5
fnmain(){
6
+
//! Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
7
+
6
8
// Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
//! Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
//! Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
7
+
8
+
// Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
Copy file name to clipboardExpand all lines: tests/source/issue-3787.rs
+1-1
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
// rustfmt-wrap_comments: true
1
+
// rustfmt-wrap_doc_comments: true
2
2
3
3
//! URLs in items
4
4
//! * [This is a link with a very loooooooooooooooooooooooooooooooooooooooooong URL.](https://example.com/This/is/a/link/with/a/very/loooooooooooooooooooooooooooooooooooooooooong/URL)
/// > For each sample received, the middleware internally maintains a sample_state relative to each DataReader. The sample_state can either be READ or NOT_READ.
Copy file name to clipboardExpand all lines: tests/source/issue-5157/nested_itemized_markdown_blockquote.rs
+1-1
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
// rustfmt-wrap_comments: true
1
+
// rustfmt-wrap_doc_comments: true
2
2
3
3
/// > For each sample received, the middleware internally maintains a sample_state relative to each DataReader. The sample_state can either be READ or NOT_READ.
/// > For each sample received, the middleware internally maintains a sample_state relative to each DataReader. The sample_state can either be READ or NOT_READ.
Copy file name to clipboardExpand all lines: tests/target/configs/wrap_comments/true.rs
+2
Original file line number
Diff line number
Diff line change
@@ -3,6 +3,8 @@
3
3
// Wrap comments
4
4
5
5
fnmain(){
6
+
//! Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
//! Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
// Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
0 commit comments