chore: working on migrating instanceof examples to switch #1391
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
cprice404
commented
Jul 16, 2024
| case CacheGetResponse.Error: | ||
| throw new Error( | ||
| `An error occurred while attempting to get key 'test-key' from cache 'test-cache': ${result.errorCode()}: ${result.toString()}` | ||
| ); | ||
| } | ||
| } | ||
|
|
There was a problem hiding this comment.
most of the changes are in the next file, which is hidden due to "large diffs" 🤦
malandis
reviewed
Jul 17, 2024
There was a problem hiding this comment.
Caught a couple small issues.
A non-blocker but for us to consider:
- Some of the inline comments are a guide to our users, eg in the topics examples where we set up a subscription, then publish.
- Others are comments that look more like to us. Can consider adding some metadata to the comment or making a comment "region" that is excluded from the docs
examples/nodejs/cache/doc-example-files/config-and-error-handling.ts
Outdated
Show resolved
Hide resolved
Comment on lines
+486
to
+487
| // eslint-disable-next-line @typescript-eslint/restrict-template-expressions | ||
| console.log(`List fetched successfully: ${result.valueList()}`); |
There was a problem hiding this comment.
Is there a way to write this line so we can remove the eslint suppression from the docs?
examples/nodejs/cache/doc-example-files/doc-examples-js-apis.ts
Outdated
Show resolved
Hide resolved
Comment on lines
+1403
to
+1404
| // Need to close the stream before the example ends or else the example will hang. | ||
| result.unsubscribe(); |
There was a problem hiding this comment.
See my comment about the parentheticals to ourselves vs users
There was a problem hiding this comment.
this seems useful for users too though?
Co-authored-by: Michael Landis <[email protected]>
…ing.ts Co-authored-by: Michael Landis <[email protected]>
malandis
approved these changes
Jul 17, 2024
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.
No description provided.