This repository has been archived by the owner on Apr 14, 2023. It is now read-only.
Made language a little clearer. #282
Merged
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
"This" in the top comment is a little unclear as it's unclear whether that comment refers to just the next message type or the entire block. "Those" on the bottom comment is a little unclear as "those" is past tense, it could refer to the preceding message types.
DxCx
reviewed
Sep 30, 2017
src/message-types.ts
Outdated
| @@ -3,7 +3,7 @@ export default class MessageTypes { | |||
| public static GQL_CONNECTION_ACK = 'connection_ack'; // Server -> Client | |||
| public static GQL_CONNECTION_ERROR = 'connection_error'; // Server -> Client | |||
|
|
|||
| // NOTE: This one here don't follow the standard due to connection optimization | |||
| // NOTE: These message types do not follow the standard due to connection optimizations | |||
There was a problem hiding this comment.
this is not true for all message types, just for KEEP_ALIVE..
DxCx
reviewed
Sep 30, 2017
src/message-types.ts
Outdated
| @@ -12,7 +12,7 @@ export default class MessageTypes { | |||
| public static GQL_COMPLETE = 'complete'; // Server -> Client | |||
| public static GQL_STOP = 'stop'; // Client -> Server | |||
|
|
|||
| // NOTE: Those message types are deprecated and will be removed soon. | |||
| // NOTE: These message types are deprecated and will be removed soon. | |||
|
@sheeldotme any updates on this? |
|
I think the fact that I tried to interpret it the best I could, and failed shows there's some opportunity for clarification here. I've taken @DxCx's helpful feedback into account and updated the comment. |
DxCx
approved these changes
Oct 4, 2017
|
Thank you for the documentation update! |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
"This" in the top comment is a little unclear as it's unclear whether that comment refers to just the next message type or the entire block.
"Those" on the bottom comment is a little unclear as "those" is past tense, it could refer to the preceding message types.
TODO: