-
-
Notifications
You must be signed in to change notification settings - Fork 275
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: improved consistency using terms Application or API #949 #950
Conversation
Changed several terms Application to Application API
There was a problem hiding this 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.
Kudos, SonarCloud Quality Gate passed! |
This is brilliant @timmiedinnie. Perfect for starting a discussion around it 👏 👏 Thanks for creating this PR. |
@@ -732,7 +732,7 @@ bindings: | |||
|
|||
Describes a publish or a subscribe operation. This provides a place to document how and why messages are sent and received. | |||
|
|||
For example, an operation might describe a chat application use case where a user sends a text message to a group. A publish operation describes messages that are received by the chat application, whereas a subscribe operation describes messages that are sent by the chat application. | |||
For example, an operation might describe a chat Application API use case where a user sends a text message to a group. A publish operation describes messages that are received by the chat Application API, whereas a subscribe operation describes messages that are sent by the chat Application API. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These are clear examples where the original term should stay.
Closing as agreed in #949 (comment) |
Changed several terms Application to Application API
"Consistency when using terms Application or API "
The suggestion to replace "Application" with "Application API" may not be suitable in most contexts. The resulting phrase, "The Application's Application programming interface," could be confusing or redundant.
In this proposed change, only a few instances of "Application" were replaced with "Application API," and it may not be appropriate in all situations. Furthermore, replacing "API" with "Application API" often creates even more awkward phrasing.
Therefore, I have submitted this pull request for review purposes only. In my opinion, using the term "API" consistently would be a better approach. Please review this pull request accordingly.
I would advise against accepting the pull request and suggest exploring alternative solutions.