Skip to content

Commit 5567a77

Browse files
committed
Include examples of all wrap_comments settings and header handling
1 parent 21719e2 commit 5567a77

File tree

1 file changed

+68
-8
lines changed

1 file changed

+68
-8
lines changed

Configurations.md

Lines changed: 68 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3097,40 +3097,100 @@ Note that no wrapping will happen if:
30973097
2. An URL was found in the comment
30983098

30993099
- **Default value**: `"off"`
3100-
- **Possible values**: `"doc"`, `"normal"`, `"all"` (alias `true`), `"off"` (alias `false`)
3100+
- **Possible values**: `"Off"` (alias `false`), `"All"` (alias `true`), `"Doc"`, `"Normal"`
31013101
- **Stable**: No (tracking issue: [#3347](https://github.com/rust-lang/rustfmt/issues/3347))
31023102

3103-
#### `"off"` (default):
3103+
#### `"Off"` (default):
31043104

31053105
```rust
3106-
// Lorem ipsum dolor sit amet, consectetur adipiscing elit,
3107-
// sed do eiusmod tempor incididunt ut labore et dolore
3108-
// magna aliqua. Ut enim ad minim veniam, quis nostrud
3109-
// exercitation ullamco laboris nisi ut aliquip ex ea
3110-
// commodo consequat.
3106+
// # This comment looks like a very long header (it starts with a '#'). Had it been a doc comment it would not have been wrapped, because wrapping a markdown header breaks it. But because it is a normal comment, it will be.
31113107

31123108
// 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.
31133109

31143110
// 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.
3111+
3112+
/// # This doc comment is a very long header (it starts with a '#'). Had it not been a header it would have been wrapped. But because it is a header, it will not be. That is because wrapping a markdown header breaks it.
3113+
///
3114+
/// 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+
///
3116+
/// 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.
31153117
struct Foo {}
31163118
```
31173119

3118-
#### `"all"`:
3120+
Can also be specified as `wrap_comments = false`.
3121+
3122+
#### `"All"`:
31193123

31203124
```rust
3125+
// # This comment looks like a very long header (it starts
3126+
// with a '#'). Had it been a doc comment it would not have
3127+
// been wrapped, because wrapping a markdown header breaks
3128+
// it. But because it is a normal comment, it will be.
3129+
31213130
// Lorem ipsum dolor sit amet, consectetur adipiscing elit,
31223131
// sed do eiusmod tempor incididunt ut labore et dolore
31233132
// magna aliqua. Ut enim ad minim veniam, quis nostrud
31243133
// exercitation ullamco laboris nisi ut aliquip ex ea
31253134
// commodo consequat.
31263135

3136+
// 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.
3137+
3138+
/// # This doc comment is a very long header (it starts with a '#'). Had it not been a header it would have been wrapped. But because it is a header, it will not be. That is because wrapping a markdown header breaks it.
3139+
///
3140+
/// Lorem ipsum dolor sit amet, consectetur adipiscing elit,
3141+
/// sed do eiusmod tempor incididunt ut labore et dolore
3142+
/// magna aliqua. Ut enim ad minim veniam, quis nostrud
3143+
/// exercitation ullamco laboris nisi ut aliquip ex ea
3144+
/// commodo consequat.
3145+
///
3146+
/// 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.
3147+
struct Foo {}
3148+
```
3149+
3150+
Can also be specified as `wrap_comments = true`.
3151+
3152+
#### `"Doc"`:
3153+
3154+
```rust
3155+
// # This comment looks like a very long header (it starts with a '#'). Had it been a doc comment it would not have been wrapped, because wrapping a markdown header breaks it. But because it is a normal comment, it will be.
3156+
3157+
// 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.
3158+
3159+
// 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.
3160+
3161+
/// # This doc comment is a very long header (it starts with a '#'). Had it not been a header it would have been wrapped. But because it is a header, it will not be. That is because wrapping a markdown header breaks it.
3162+
///
3163+
/// Lorem ipsum dolor sit amet, consectetur adipiscing elit,
3164+
/// sed do eiusmod tempor incididunt ut labore et dolore
3165+
/// magna aliqua. Ut enim ad minim veniam, quis nostrud
3166+
/// exercitation ullamco laboris nisi ut aliquip ex ea
3167+
/// commodo consequat.
3168+
///
3169+
/// 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.
3170+
struct Foo {}
3171+
```
3172+
3173+
#### `"Normal"`:
3174+
3175+
```rust
3176+
// # This comment looks like a very long header (it starts
3177+
// with a '#'). Had it been a doc comment it would not have
3178+
// been wrapped, because wrapping a markdown header breaks
3179+
// it. But because it is a normal comment, it will be.
3180+
31273181
// Lorem ipsum dolor sit amet, consectetur adipiscing elit,
31283182
// sed do eiusmod tempor incididunt ut labore et dolore
31293183
// magna aliqua. Ut enim ad minim veniam, quis nostrud
31303184
// exercitation ullamco laboris nisi ut aliquip ex ea
31313185
// commodo consequat.
31323186

31333187
// 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.
3188+
3189+
/// # This doc comment is a very long header (it starts with a '#'). Had it not been a header it would have been wrapped. But because it is a header, it will not be. That is because wrapping a markdown header breaks it.
3190+
///
3191+
/// 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.
3192+
///
3193+
/// 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.
31343194
struct Foo {}
31353195
```
31363196

0 commit comments

Comments
 (0)