Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: adds C++ constraint docs #1696

Merged
merged 5 commits into from
Dec 28, 2023

Conversation

ankur0904
Copy link
Contributor

Description

Adds the missing C++ constraint docs.

Related Issue

Fix #1671

Copy link

netlify bot commented Dec 26, 2023

Deploy Preview for modelina canceled.

Name Link
🔨 Latest commit e04ed20
🔍 Latest deploy log https://app.netlify.com/sites/modelina/deploys/658c6e0a3ba81200088bb55e

Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@coveralls
Copy link

coveralls commented Dec 26, 2023

Pull Request Test Coverage Report for Build 7340979409

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 92.297%

Totals Coverage Status
Change from base Build 7340100934: 0.0%
Covered Lines: 5865
Relevant Lines: 6193

💛 - Coveralls

Copy link
Sponsor Member

@jonaslagoni jonaslagoni left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just got one comment 💪

|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/cplusplus/Constants.ts))|
|NAMING_FORMATTER|Must be formatted equally|Model name is formatted using pascal case|
Copy link
Sponsor Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The model namings use toSnakeCase function not pascal case, please double check that the implementation and docs (for all the constraints) are matching: https://github.com/asyncapi/modelina/blob/cbf55179f37adaa9b67564b2fc022615d7c66095/src/generators/cplusplus/constrainer/EnumConstrainer.ts#L42C35-L42C46

Copy link

sonarcloud bot commented Dec 27, 2023

Quality Gate Passed Quality Gate passed

Kudos, no new issues were introduced!

0 New issues
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

@ankur0904
Copy link
Contributor Author

@jonaslagoni Made some changes. Notice that only _ is excluded in the code, so I removed the $ sign as well.

//Exclude '_' because they are allowed as enum keys

Copy link
Sponsor Member

@jonaslagoni jonaslagoni left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool, thanks @ankur0904 🤙

@jonaslagoni jonaslagoni merged commit 37a5306 into asyncapi:master Dec 28, 2023
15 checks passed
@ankur0904
Copy link
Contributor Author

hey, @jonaslagoni can I become part of a contributor for doc, maintenance?

@jonaslagoni
Copy link
Sponsor Member

@ankur0904 docs for sure, however maintenance is for those who are code owners 😄

If you want to become a codeowner read more here: #1148

@jonaslagoni
Copy link
Sponsor Member

@all-contributors please add @ankur0904 for docs

Copy link
Contributor

@jonaslagoni

I've put up a pull request to add @ankur0904! 🎉

@ankur0904
Copy link
Contributor Author

Thanks @jonaslagoni

@asyncapi-bot
Copy link
Contributor

🎉 This PR is included in version 3.0.0-next.11 🎉

The release is available on:

Your semantic-release bot 📦🚀

@asyncapi-bot
Copy link
Contributor

🎉 This PR is included in version 2.1.2 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add missing C++ constraint docs
4 participants