docs: improved consistency using terms Application or API #949 #950
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Changed several terms Application to Application API
timmiedinnie
requested review from
fmvilas,
derberg,
dalelane,
smoya,
char0n and
asyncapi-bot-eve
as code owners
![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.
|
Kudos, SonarCloud Quality Gate passed!
|
timmiedinnie
changed the title
|
This is brilliant @timmiedinnie. Perfect for starting a discussion around it 👏 👏 Thanks for creating this PR. |
smoya
reviewed
Jun 30, 2023
| @@ -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.
These are clear examples where the original term should stay.
|
Closing as agreed in #949 (comment) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.