From c58307c75a03b1bc377d2bf99ff82edb75eda5f2 Mon Sep 17 00:00:00 2001 From: Sam Harwell Date: Wed, 19 May 2021 14:50:18 -0700 Subject: [PATCH] Clarify documentation --- documentation/Configuration.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/documentation/Configuration.md b/documentation/Configuration.md index 7ef4f4407..8f0ce75b0 100644 --- a/documentation/Configuration.md +++ b/documentation/Configuration.md @@ -420,7 +420,7 @@ The following properties are used to configure layout rules in StyleCop Analyzer | --- | --- | --- | --- | | `newlineAtEndOfFile` | `"allow"` | 1.0.0 | Specifies the handling for newline characters which appear at the end of a file | | `allowConsecutiveUsings` | `true` | 1.1.0 | Specifies if SA1519 will allow consecutive using statements without braces | -| `allowDoWhileOnClosingBrace` | `false` | >1.2.0 | Specifies if SA1500 will allow the `while` expression of a `do-while` loop to be on the same line as the closing brace, as is generated by the default code snippet of Visual Studio | +| `allowDoWhileOnClosingBrace` | `false` | >1.2.0 | Specifies if SA1500 will allow the `while` expression of a `do`/`while` loop to be on the same line as the closing brace, as is generated by the default code snippet of Visual Studio | ### Lines at End of File @@ -444,10 +444,10 @@ require braces to used. ### Do-While Loop Placement -The behavior of [SA1500](SA1500.md) can be customized regarding the manner in which the `while` expression of a `do-while` loop is allowed to be placed. The `allowDoWhileOnClosingBrace` property specified the behavior: +The behavior of [SA1500](SA1500.md) can be customized regarding the manner in which the `while` expression of a `do`/`while` loop is allowed to be placed. The `allowDoWhileOnClosingBrace` property specified the behavior: -* `true`: the `while` expression of a `do-while` loop may be placed on the same line as the closing brace -* `false`: the `while` expression of a `do-while` loop must be on a separate line from the closing brace +* `true`: the `while` expression of a `do`/`while` loop may be placed on the same line as the closing brace or on a separate line +* `false`: the `while` expression of a `do`/`while` loop must be on a separate line from the closing brace ## Documentation Rules