From 1ebfd0e7ce83d8249c6b07910b997adafe8fde73 Mon Sep 17 00:00:00 2001 From: Asish Kumar <87874775+officialasishkumar@users.noreply.github.com> Date: Wed, 27 Dec 2023 21:56:33 +0530 Subject: [PATCH] docs: updated wrong section name in NAMING_FORMATTER in constraint docs for all languages (#1688) --- docs/constraints/CSharp.md | 4 ++-- docs/constraints/Dart.md | 4 ++-- docs/constraints/Go.md | 4 ++-- docs/constraints/Java.md | 4 ++-- docs/constraints/JavaScript.md | 4 ++-- docs/constraints/Rust.md | 2 +- docs/constraints/TypeScript.md | 4 ++-- 7 files changed, 13 insertions(+), 13 deletions(-) diff --git a/docs/constraints/CSharp.md b/docs/constraints/CSharp.md index 17e1d5be9e..556cfd7a9a 100644 --- a/docs/constraints/CSharp.md +++ b/docs/constraints/CSharp.md @@ -21,7 +21,7 @@ These are the constraints that is applied to object properties and the naming of |NO_NUMBER_START_CHAR|No numbers as starting characters|Default behavior is pre pending `number_` in front of the first character| |NO_EMPTY_VALUE|No empty values|Default behavior is to use `empty` as name. | |NO_RESERVED_KEYWORDS|No reserved keywords|C# has a list of reserved keywords ([see the full list here](../../src/generators/csharp/Constants.ts))| -|NAMING_FORMATTER|Must be formatted equally|Model name is formatted using pascal case| +|NAMING_FORMATTER|Must be formatted equally|Property name is formatted using pascal case| |NO_DUPLICATE_PROPERTIES|No duplicate properties|If any of the above constraints changes the property name, we must make sure that no duplicates exist within the same object. If any is encountered `reserved_` is pre-pended. This is done recursively until no duplicates are found.| @@ -34,7 +34,7 @@ These are the constraints that is applied to enum keys. The `Rule key` is what y |NO_NUMBER_START_CHAR|No numbers as starting characters|Default behavior is pre pending `number_` in front of the first character| |NO_EMPTY_VALUE|No empty values|Default behavior is to use `empty` as name. | |NO_RESERVED_KEYWORDS|No reserved keywords|C# has a list of reserved keywords ([see the full list here](../../src/generators/csharp/Constants.ts))| -|NAMING_FORMATTER|Must be formatted equally|Model name is formatted using pascal case| +|NAMING_FORMATTER|Must be formatted equally|Enum name is formatted using pascal case| |NO_DUPLICATE_KEYS|No duplicate enum keys|If any of the above constraints changes the enum key, we must make sure that no duplicates exist within the same enum. If any is encountered `reserved_` is pre-pended. This is done recursively until no duplicates are found.| ## Constant diff --git a/docs/constraints/Dart.md b/docs/constraints/Dart.md index d545a6f9bd..1639f0a2d2 100644 --- a/docs/constraints/Dart.md +++ b/docs/constraints/Dart.md @@ -21,7 +21,7 @@ These are the constraints that is applied to object properties and the naming of |NO_NUMBER_START_CHAR|No numbers as starting characters|Default behavior is pre pending `number_` in front of the first character| |NO_EMPTY_VALUE|No empty values|Default behavior is to use `empty` as name. | |NO_RESERVED_KEYWORDS|No reserved keywords|Dart has a list of reserved keywords ([see the full list here](../../src/generators/dart/Constants.ts))| -|NAMING_FORMATTER|Must be formatted equally|Model name is formatted using pascal case| +|NAMING_FORMATTER|Must be formatted equally|Property name is formatted using pascal case| |NO_DUPLICATE_PROPERTIES|No duplicate properties|If any of the above constraints changes the property name, we must make sure that no duplicates exist within the same object. If any is encountered `reserved_` is pre-pended. This is done recursively until no duplicates are found.| @@ -34,7 +34,7 @@ These are the constraints that is applied to enum keys. The `Rule key` is what y |NO_NUMBER_START_CHAR|No numbers as starting characters|Default behavior is pre pending `number_` in front of the first character| |NO_EMPTY_VALUE|No empty values|Default behavior is to use `empty` as name. | |NO_RESERVED_KEYWORDS|No reserved keywords|Dart has a list of reserved keywords ([see the full list here](../../src/generators/dart/Constants.ts))| -|NAMING_FORMATTER|Must be formatted equally|Model name is formatted using pascal case| +|NAMING_FORMATTER|Must be formatted equally|Enum name is formatted using pascal case| |NO_DUPLICATE_KEYS|No duplicate enum keys|If any of the above constraints changes the enum key, we must make sure that no duplicates exist within the same enum. If any is encountered `reserved_` is pre-pended. This is done recursively until no duplicates are found.| ## Constant diff --git a/docs/constraints/Go.md b/docs/constraints/Go.md index ef693d8383..7ee88faddb 100644 --- a/docs/constraints/Go.md +++ b/docs/constraints/Go.md @@ -21,7 +21,7 @@ These are the constraints that is applied to object properties and the naming of |NO_NUMBER_START_CHAR|No numbers as starting characters|Default behavior is pre pending `number_` in front of the first character| |NO_EMPTY_VALUE|No empty values|Default behavior is to use `empty` as name. | |NO_RESERVED_KEYWORDS|No reserved keywords|Go has a list of reserved keywords ([see the full list here](../../src/generators/go/Constants.ts))| -|NAMING_FORMATTER|Must be formatted equally|Model name is formatted using pascal case| +|NAMING_FORMATTER|Must be formatted equally|Property name is formatted using pascal case| |NO_DUPLICATE_PROPERTIES|No duplicate properties|If any of the above constraints changes the property name, we must make sure that no duplicates exist within the same object. If any is encountered `reserved_` is pre-pended. This is done recursively until no duplicates are found.| @@ -34,7 +34,7 @@ These are the constraints that is applied to enum keys. The `Rule key` is what y |NO_NUMBER_START_CHAR|No numbers as starting characters|Default behavior is pre pending `number_` in front of the first character| |NO_EMPTY_VALUE|No empty values|Default behavior is to use `empty` as name. | |NO_RESERVED_KEYWORDS|No reserved keywords|Go has a list of reserved keywords ([see the full list here](../../src/generators/go/Constants.ts))| -|NAMING_FORMATTER|Must be formatted equally|Model name is formatted using pascal case| +|NAMING_FORMATTER|Must be formatted equally|Enum name is formatted using pascal case| |NO_DUPLICATE_KEYS|No duplicate enum keys|If any of the above constraints changes the enum key, we must make sure that no duplicates exist within the same enum. If any is encountered `reserved_` is pre-pended. This is done recursively until no duplicates are found.| ## Constant diff --git a/docs/constraints/Java.md b/docs/constraints/Java.md index 29f0ff2f82..60db4a7b80 100644 --- a/docs/constraints/Java.md +++ b/docs/constraints/Java.md @@ -21,7 +21,7 @@ These are the constraints that is applied to object properties and the naming of |NO_NUMBER_START_CHAR|No numbers as starting characters|Default behavior is pre pending `number_` in front of the first character| |NO_EMPTY_VALUE|No empty values|Default behavior is to use `empty` as name. | |NO_RESERVED_KEYWORDS|No reserved keywords|Java has a list of reserved keywords ([see the full list here](../../src/generators/java/Constants.ts))| -|NAMING_FORMATTER|Must be formatted equally|Model name is formatted using pascal case| +|NAMING_FORMATTER|Must be formatted equally|Property name is formatted using pascal case| |NO_DUPLICATE_PROPERTIES|No duplicate properties|If any of the above constraints changes the property name, we must make sure that no duplicates exist within the same object. If any is encountered `reserved_` is pre-pended. This is done recursively until no duplicates are found.| @@ -34,7 +34,7 @@ These are the constraints that is applied to enum keys. The `Rule key` is what y |NO_NUMBER_START_CHAR|No numbers as starting characters|Default behavior is pre pending `number_` in front of the first character| |NO_EMPTY_VALUE|No empty values|Default behavior is to use `empty` as name. | |NO_RESERVED_KEYWORDS|No reserved keywords|Java has a list of reserved keywords ([see the full list here](../../src/generators/java/Constants.ts))| -|NAMING_FORMATTER|Must be formatted equally|Model name is formatted using pascal case| +|NAMING_FORMATTER|Must be formatted equally|Enum name is formatted using pascal case| |NO_DUPLICATE_KEYS|No duplicate enum keys|If any of the above constraints changes the enum key, we must make sure that no duplicates exist within the same enum. If any is encountered `reserved_` is pre-pended. This is done recursively until no duplicates are found.| ## Constant diff --git a/docs/constraints/JavaScript.md b/docs/constraints/JavaScript.md index 742a580086..96b685be25 100644 --- a/docs/constraints/JavaScript.md +++ b/docs/constraints/JavaScript.md @@ -21,7 +21,7 @@ These are the constraints that is applied to object properties and the naming of |NO_NUMBER_START_CHAR|No numbers as starting characters|Default behavior is pre pending `number_` in front of the first character| |NO_EMPTY_VALUE|No empty values|Default behavior is to use `empty` as name. | |NO_RESERVED_KEYWORDS|No reserved keywords|JavaScript has a list of reserved keywords ([see the full list here](../../src/generators/javascript/Constants.ts))| -|NAMING_FORMATTER|Must be formatted equally|Model name is formatted using pascal case| +|NAMING_FORMATTER|Must be formatted equally|Property name is formatted using pascal case| |NO_DUPLICATE_PROPERTIES|No duplicate properties|If any of the above constraints changes the property name, we must make sure that no duplicates exist within the same object. If any is encountered `reserved_` is pre-pended. This is done recursively until no duplicates are found.| @@ -34,7 +34,7 @@ These are the constraints that is applied to enum keys. The `Rule key` is what y |NO_NUMBER_START_CHAR|No numbers as starting characters|Default behavior is pre pending `number_` in front of the first character| |NO_EMPTY_VALUE|No empty values|Default behavior is to use `empty` as name. | |NO_RESERVED_KEYWORDS|No reserved keywords|JavaScript has a list of reserved keywords ([see the full list here](../../src/generators/javascript/Constants.ts))| -|NAMING_FORMATTER|Must be formatted equally|Model name is formatted using pascal case| +|NAMING_FORMATTER|Must be formatted equally|Enum name is formatted using pascal case| |NO_DUPLICATE_KEYS|No duplicate enum keys|If any of the above constraints changes the enum key, we must make sure that no duplicates exist within the same enum. If any is encountered `reserved_` is pre-pended. This is done recursively until no duplicates are found.| ## Constant diff --git a/docs/constraints/Rust.md b/docs/constraints/Rust.md index 611532c9c5..fd304b7e28 100644 --- a/docs/constraints/Rust.md +++ b/docs/constraints/Rust.md @@ -33,7 +33,7 @@ These are the constraints that is applied to enum keys. The `Rule key` is what y |NO_NUMBER_START_CHAR|No numbers as starting characters|Default behavior is pre pending `number_` in front of the first character| |NO_EMPTY_VALUE|No empty values|Default behavior is to use `empty` as name. | |NO_RESERVED_KEYWORDS|No reserved keywords|Rust has a list of reserved keywords ([see the full list here](../../src/generators/rust/Constants.ts))| -|NAMING_FORMATTER|Must be formatted equally|Model name is formatted using pascal case| +|NAMING_FORMATTER|Must be formatted equally|Enum name is formatted using pascal case| |NO_DUPLICATE_KEYS|No duplicate enum keys|If any of the above constraints changes the enum key, we must make sure that no duplicates exist within the same enum. If any is encountered `reserved_` is pre-pended. This is done recursively until no duplicates are found.| ## Constant diff --git a/docs/constraints/TypeScript.md b/docs/constraints/TypeScript.md index 85fc33b9cc..41095ddcfa 100644 --- a/docs/constraints/TypeScript.md +++ b/docs/constraints/TypeScript.md @@ -21,7 +21,7 @@ These are the constraints that is applied to object properties and the naming of |NO_NUMBER_START_CHAR|No numbers as starting characters|Default behavior is pre pending `number_` in front of the first character| |NO_EMPTY_VALUE|No empty values|Default behavior is to use `empty` as name. | |NO_RESERVED_KEYWORDS|No reserved keywords|TypeScript has a list of reserved keywords ([see the full list here](../../src/generators/typescript/Constants.ts))| -|NAMING_FORMATTER|Must be formatted equally|Model name is formatted using pascal case| +|NAMING_FORMATTER|Must be formatted equally|Property name is formatted using pascal case| |NO_DUPLICATE_PROPERTIES|No duplicate properties|If any of the above constraints changes the property name, we must make sure that no duplicates exist within the same object. If any is encountered `reserved_` is pre-pended. This is done recursively until no duplicates are found.| @@ -34,7 +34,7 @@ These are the constraints that is applied to enum keys. The `Rule key` is what y |NO_NUMBER_START_CHAR|No numbers as starting characters|Default behavior is pre pending `number_` in front of the first character| |NO_EMPTY_VALUE|No empty values|Default behavior is to use `empty` as name. | |NO_RESERVED_KEYWORDS|No reserved keywords|TypeScript has a list of reserved keywords ([see the full list here](../../src/generators/typescript/Constants.ts))| -|NAMING_FORMATTER|Must be formatted equally|Model name is formatted using pascal case| +|NAMING_FORMATTER|Must be formatted equally|Enum name is formatted using pascal case| |NO_DUPLICATE_KEYS|No duplicate enum keys|If any of the above constraints changes the enum key, we must make sure that no duplicates exist within the same enum. If any is encountered `reserved_` is pre-pended. This is done recursively until no duplicates are found.| ## Constant