Skip to content

Commit

Permalink
Improve docs
Browse files Browse the repository at this point in the history
  • Loading branch information
karlhorky committed Dec 2, 2023
1 parent 8d81244 commit a4e4070
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 7 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,8 @@ All fields are optional and all fields that are not specified will be filled wit
- [**`useTabs`**](docs/useTabs.md) to use tabs for indentation.
- [**`keywordCase`**](docs/keywordCase.md) uppercases or lowercases keywords.
- [**`identifierCase`**](docs/identifierCase.md) uppercases or lowercases identifiers. (**experimental!**)
- [**`dataTypeCase`**](docs/dataTypeCase.md) uppercases or lowercases data types. (**experimental!**)
- [**`functionCase`**](docs/functionCase.md) uppercases or lowercases function names. (**experimental!**)
- [**`indentStyle`**](docs/indentStyle.md) defines overall indentation style.
- [**`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.
Expand Down
6 changes: 3 additions & 3 deletions docs/dataTypeCase.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Note: Casing of function names like `VARCHAR(30)` are not modified - instead rel
CREATE TABLE
users (
id InTeGeR PRIMARY KEY GENERATED ALWAYS AS IDENTITY,
first_name VARCHAR(30) NOT NULL,
first_name VarChaR(30) NOT NULL,
bio teXT,
is_email_verified BooL NOT NULL DEFAULT FALSE,
created_timestamp timestamPtz NOT NULL DEFAULT NOW()
Expand All @@ -31,7 +31,7 @@ CREATE TABLE
CREATE TABLE
users (
id INTEGER PRIMARY KEY GENERATED ALWAYS AS IDENTITY,
first_name VARCHAR(30) NOT NULL,
first_name VarChaR(30) NOT NULL,
bio TEXT,
is_email_verified BOOL NOT NULL DEFAULT FALSE,
created_timestamp TIMESTAMPTZ NOT NULL DEFAULT NOW()
Expand All @@ -44,7 +44,7 @@ CREATE TABLE
CREATE TABLE
users (
id integer PRIMARY KEY GENERATED ALWAYS AS IDENTITY,
first_name VARCHAR(30) NOT NULL,
first_name VarChaR(30) NOT NULL,
bio text,
is_email_verified bool NOT NULL DEFAULT FALSE,
created_timestamp timestamptz NOT NULL DEFAULT NOW()
Expand Down
8 changes: 4 additions & 4 deletions docs/functionCase.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# functionCase (experimental)

Converts functions to upper- or lowercase.
Converts function names to upper- or lowercase.

## Options

Expand All @@ -11,7 +11,7 @@ Converts functions to upper- or lowercase.
### preserve

```sql
CREATE tabLE
CREATE TABLE
users (
id iNtegeR PRIMARY KEY GENERATED ALWAYS AS IDENTITY,
first_name VarChaR(30) NOT NULL,
Expand All @@ -24,7 +24,7 @@ CREATE tabLE
### upper

```sql
CREATE tabLE
CREATE TABLE
users (
id iNtegeR PRIMARY KEY GENERATED ALWAYS AS IDENTITY,
first_name VARCHAR(30) NOT NULL,
Expand All @@ -37,7 +37,7 @@ CREATE tabLE
### lower

```sql
CREATE tabLE
CREATE TABLE
users (
id iNtegeR PRIMARY KEY GENERATED ALWAYS AS IDENTITY,
first_name varchar(30) NOT NULL,
Expand Down

0 comments on commit a4e4070

Please sign in to comment.