DOCSP-32718: add CodeWhisperer comments to SOCKS5 code snippet #765
Conversation
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
jordan-smith721
approved these changes
Sep 1, 2023
| @@ -13,6 +15,7 @@ const socksOptions = { | |||
| const client = new MongoClient(uri, socksOptions); | |||
There was a problem hiding this comment.
Suggestion: Add a comment above this specifying that it is connecting and passing in the socksOptions
| @@ -13,6 +15,7 @@ const socksOptions = { | |||
| const client = new MongoClient(uri, socksOptions); | |||
| // end-socks | |||
|
|
|||
| // Retrieve the first document from the "myDB.myColl" namespace in MongoDB and print it to the console | |||
| async function run() { | |||
| try { | |||
| const db = client.db("myDB"); | |||
There was a problem hiding this comment.
Suggestion: Add a comment on the await client.close() section (line 25, can't reach it with a PR comment) stating that it is closing the client when complete. This is to match similar comments in other files
ccho-mongodb
pushed a commit
that referenced
this pull request
Sep 8, 2023
* DOCSP-32718: add CodeWhisperer comments to SOCKS5 code snippet (cherry picked from commit 72bfca1)
mongoKart
pushed a commit
to mongoKart/docs-node
that referenced
this pull request
Nov 3, 2023
…db#765) * DOCSP-32718: add CodeWhisperer comments to SOCKS5 code snippet
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.
Pull Request Info
PR Reviewing Guidelines
JIRA - https://jira.mongodb.org/browse/DOCSP-32718
Staging - https://docs-mongodbcom-staging.corp.mongodb.com/node/docsworker-xlarge/DOCSP-32718-socks5-snippet/fundamentals/connection/socks/
Self-Review Checklist