docs: updated wrong section name in NAMING_FORMATTER in constraint docs for all languages #1688
Conversation
Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
✅ Deploy Preview for modelina canceled.
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Welcome to AsyncAPI. Thanks a lot for creating your first pull request. Please check out our contributors guide useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.
|
@devilkiller-ag Please take a look! |
docs/constraints/TypeScript.md
Outdated
| @@ -11,7 +11,7 @@ These are the constraints that is applied to model naming. The `Rule key` is wha | |||
| |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| | |||
There was a problem hiding this comment.
This section here is actually for the Model naming formatted 🙂 So this needs to be reverted. The other section is correct 👍
Remember to propagate it across languages 🙂
There was a problem hiding this comment.
Hey @jonaslagoni, Thanks for the review! I made the necessary changes.
Pull Request Test Coverage Report for Build 7340096141Warning: This coverage report may be inaccurate.We've detected an issue with your CI configuration that might affect the accuracy of this pull request's coverage report.
💛 - Coveralls |
Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
docs/constraints/CSharp.md
Outdated
| @@ -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|Property name is formatted using pascal case| | |||
There was a problem hiding this comment.
This one here is for the enum keys and how they are formatted, not the property name 🙂 Same applies for all the constraints.
Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
|
/rtm |
|
@all-contributors please add @officialasishkumar for docs |
|
|
I've put up a pull request to add @officialasishkumar! 🎉 |
|
🎉 This PR is included in version 3.0.0-next.11 🎉 The release is available on: Your semantic-release bot 📦🚀 |
|
🎉 This PR is included in version 2.1.2 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Description
Updated NAME_FORMATTER in constraint docs for all languages
Related Issue
Fixes #1678
Checklist
npm run lint).npm run test).Additional Notes