Merge pull request #3145 from otavio/allow-failure-for-crater

[rust.git] / Configurations.md

diff --git a/Configurations.md b/Configurations.md
index 824868bca098290a33e8404a903d5eb2d9d4034b..3eb8cbd780f28e1a31cf0214d83fa63d7692cfe0 100644 (file)
--- a/Configurations.md
+++ b/Configurations.md
@@ -236,7 +236,7 @@ fn main() {
 ```rust
 fn main() {
     let lorem = Lorem { ipsum: dolor,
-                        sit: amet, };
+                        sit: amet };
 }
 ```
 
@@ -1979,6 +1979,56 @@ fn main() {
 }
 ```
 
+## `format_doc_comments`
+
+Format doc comments.
+
+- **Default value**: `false`
+- **Possible values**: `true`, `false`
+- **Stable**: No
+
+#### `false` (default):
+
+```rust
+/// Adds one to the number given.
+///
+/// # Examples
+///
+/// ```rust
+/// let five=5;
+///
+/// assert_eq!(
+///     6,
+///     add_one(5)
+/// );
+/// # fn add_one(x: i32) -> i32 {
+/// #     x + 1
+/// # }
+/// ```
+fn add_one(x: i32) -> i32 {
+    x + 1
+}
+```
+
+#### `true`
+
+```rust
+/// Adds one to the number given.
+///
+/// # Examples
+///
+/// ```rust
+/// let five = 5;
+///
+/// assert_eq!(6, add_one(5));
+/// # fn add_one(x: i32) -> i32 {
+/// #     x + 1
+/// # }
+/// ```
+fn add_one(x: i32) -> i32 {
+    x + 1
+}
+```
 
 ## `wrap_comments`
 
@@ -2225,7 +2275,7 @@ Specifies which edition is used by the parser.
 
 - **Default value**: `2015`
 - **Possible values**: `2015`, `2018`
-- **Stable**: No
+- **Stable**: Yes
 
 ### Example