Repository navigation
docs(graphql): fix undefined names in README code samples and typos - #1533
Merged
Merged
Conversation
The "Basic Usage" setup sample declares `websocketEndpoint` but passes `websockeEndpoint` to `WebSocketLink(...)`, and the generated-code mutation sample passes `starableId:` where the operation declares `$starrableId`. Both fail to compile when copied. Also fix the mis-cased `WebsocketLink` class name in the links section, a stray period in the setup sample's comment, and four spelling errors (retreived, cooresponding, indistiguishable, systm).
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1533 +/- ##
==========================================
- Coverage 65.93% 65.83% -0.10%
==========================================
Files 43 43
Lines 2096 2096
==========================================
- Hits 1382 1380 -2
- Misses 714 716 +2
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
This file contains hidden or 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
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.
The
packages/graphqlREADME has two code samples that fail to compile when copied, plus a few spelling errors. This PR fixes them; no code changes.Docs
websocketEndpoint != nullbut then passeswebsockeEndpointtoWebSocketLink(...), an undefined name.AddStarsample:VariablesMutationAddStar(starableId: ...)where the operation declares$starrableId.WebsocketLinkclass name in thegql_linkrouting notes (the class isWebSocketLink).