From 9c4073c8106e11cdff70f6325cae7fb6af013e2a Mon Sep 17 00:00:00 2001 From: Rene Saarsoo Date: Mon, 22 Jan 2024 14:21:55 +0200 Subject: [PATCH] Mark the indentStyle config option as deprecated --- README.md | 2 +- docs/indentStyle.md | 3 ++- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0af55c3c9b..12bee84efb 100644 --- a/README.md +++ b/README.md @@ -181,7 +181,7 @@ All fields are optional and all fields that are not specified will be filled wit - [**`dataTypeCase`**](docs/dataTypeCase.md) uppercases or lowercases data types. - [**`functionCase`**](docs/functionCase.md) uppercases or lowercases function names. - [**`identifierCase`**](docs/identifierCase.md) uppercases or lowercases identifiers. (**experimental!**) -- [**`indentStyle`**](docs/indentStyle.md) defines overall indentation style. +- [**`indentStyle`**](docs/indentStyle.md) defines overall indentation style. (**deprecated!**) - [**`logicalOperatorNewline`**](docs/logicalOperatorNewline.md) newline before or after boolean operator (AND, OR, XOR). - [**`expressionWidth`**](docs/expressionWidth.md) maximum number of characters in parenthesized expressions to be kept on single line. - [**`linesBetweenQueries`**](docs/linesBetweenQueries.md) how many newlines to insert between queries. diff --git a/docs/indentStyle.md b/docs/indentStyle.md index 8915b96e16..43ec7e7716 100644 --- a/docs/indentStyle.md +++ b/docs/indentStyle.md @@ -1,4 +1,4 @@ -# indentStyle +# indentStyle (DEPRECATED!) Switches between different indentation styles. @@ -11,6 +11,7 @@ Switches between different indentation styles. Caveats of using `"tabularLeft"` and `"tabularRight"`: - `tabWidth` option is ignored. Indentation will always be 10 spaces, regardless of what is specified by `tabWidth`. +- The implementation of these styles is more of a bolted-on feature which has never worked quite as well as the `"standard"` style. ### standard