Added code comments #772

jordan-smith721 · 2023-08-30T16:52:05Z

Pull Request Info

JIRA - https://jira.mongodb.org/browse/DOCSP-32718
Staging - https://docs-mongodbcom-staging.corp.mongodb.com/node/docsworker-xlarge/DOCSP-32718-code-commenting/

Self-Review Checklist

Is this free of any warnings or errors in the RST?
Did you run a spell-check?
Did you run a grammar-check?
Are all the links working?

norareidy · 2023-08-31T16:14:46Z

source/code-snippets/crud/startrek.js

@@ -1,12 +1,14 @@
+/* Text search */
+
 const { MongoClient } = require("mongodb");

 // Replace the following string with your MongoDB deployment's connection string.


Suggested change

// Replace the following string with your MongoDB deployment's connection string.

// Replace the following string with your MongoDB deployment's connection string

norareidy

LGTM + small suggestions

norareidy · 2023-08-31T16:17:40Z

source/code-snippets/crud/startrek.js

 const client = new MongoClient(uri);

 async function word(movies) {
  // start word text example
+  // Create a query that searches for the specified string


Suggested change

// Create a query that searches for the specified string

// Create a query that searches for the "trek" string

norareidy · 2023-08-31T16:20:01Z

source/code-snippets/crud/startrek.js

  for await (const doc of cursor) {
    console.dir(doc);
  } 
 }

 async function phrase(movies) {
  // start phrase text example
+  // Create a query that searches for the specified phrase


Suggested change

// Create a query that searches for the specified phrase

// Create a query that searches for the phrase "star trek"

norareidy · 2023-08-31T16:21:38Z

source/code-snippets/crud/startrek.js

  for await (const doc of cursor) {
    console.dir(doc);
  } 
 }

 async function negation(movies) {
  // start negation text example
+  // Create a query that searches for a specified phrase while omitting another


Suggested change

// Create a query that searches for a specified phrase while omitting another

// Create a query that searches for a specified phrase while omitting the "into darkness" phrase

norareidy · 2023-08-31T16:24:37Z

source/code-snippets/crud/startrek.js

  for await (const doc of cursor) {
    console.dir(doc);
  } 
 }

 async function relevance(movies) {
  // start relevance text example
+  // Create a query that searches for a specified phrase while omitting another


Suggested change

// Create a query that searches for a specified phrase while omitting another

// Create a query that searches for a specified phrase while omitting the "into darkness" phrase

norareidy · 2023-08-31T16:25:32Z

source/code-snippets/monitoring/apm-subscribe.js

-// string.
-const uri =
-  "mongodb+srv://<clusterUrl>/?replicaSet=rs&writeConcern=majority";
+// Replace the following with your MongoDB deployment's connection string.


Suggested change

// Replace the following with your MongoDB deployment's connection string.

// Replace the following with your MongoDB deployment's connection string

norareidy · 2023-08-31T17:04:03Z

source/code-snippets/usage-examples/updateMany.js

@@ -1,3 +1,5 @@
+/* Update multiple documents */
+
 import { MongoClient } from "mongodb";

 // Replace the uri string with your MongoDB deployment's connection string.


Suggested change

// Replace the uri string with your MongoDB deployment's connection string.

// Replace the uri string with your MongoDB deployment's connection string

norareidy · 2023-08-31T17:04:31Z

source/code-snippets/usage-examples/updateMany.js

@@ -10,20 +12,22 @@ async function run() {
    const database = client.db("sample_mflix");
    const movies = database.collection("movies");


S: briefly explain what these two lines are doing

norareidy · 2023-08-31T17:07:23Z

source/code-snippets/usage-examples/updateMany.ts

@@ -1,3 +1,5 @@
+/* Update multiple documents */
+
 import { MongoClient } from "mongodb";

 // Replace the uri string with your MongoDB deployment's connection string.


Suggested change

// Replace the uri string with your MongoDB deployment's connection string.

// Replace the uri string with your MongoDB deployment's connection string

norareidy · 2023-08-31T17:12:05Z

source/code-snippets/usage-examples/updateMany.ts

@@ -22,6 +25,8 @@ async function run() {
  try {
    const database = client.db("sample_mflix");


S: comment that the user is connecting to the "sample_mflix" database

norareidy · 2023-08-31T17:12:47Z

source/code-snippets/usage-examples/updateMany.ts

@@ -22,6 +25,8 @@ async function run() {
  try {
    const database = client.db("sample_mflix");
    const movies = database.collection<Movie>("movies");


S: comment that the collection is "movies"

(cherry picked from commit 5b0652a)

* DOCSP-31824: Update page titles (#774) (cherry picked from commit 9cd60b1) * DOCSP-30081: Fix find to find() * docsp-32718 - add comments (#770) (cherry picked from commit 11461c3) * Added code comments (#772) (#778) (cherry picked from commit 5b0652a) * removed nested components * fixing bulkWrite * Fixing bulkwrite --------- Co-authored-by: Nora Reidy <[email protected]> Co-authored-by: Mike Woofter <[email protected]> Co-authored-by: Jordan Smith <[email protected]>

* DOCSP-31824: Update page titles (mongodb#774) (cherry picked from commit 9cd60b1) * DOCSP-30081: Fix find to find() * docsp-32718 - add comments (mongodb#770) (cherry picked from commit 11461c3) * Added code comments (mongodb#772) (mongodb#778) (cherry picked from commit 5b0652a) * removed nested components * fixing bulkWrite * Fixing bulkwrite --------- Co-authored-by: Nora Reidy <[email protected]> Co-authored-by: Mike Woofter <[email protected]> Co-authored-by: Jordan Smith <[email protected]> (cherry picked from commit fa3f2bc)

* DOCSP-31824: Update page titles (#774) (cherry picked from commit 9cd60b1) * DOCSP-30081: Fix find to find() * docsp-32718 - add comments (#770) (cherry picked from commit 11461c3) * Added code comments (#772) (#778) (cherry picked from commit 5b0652a) * removed nested components * fixing bulkWrite * Fixing bulkwrite --------- Co-authored-by: Nora Reidy <[email protected]> Co-authored-by: Mike Woofter <[email protected]> Co-authored-by: Jordan Smith <[email protected]> (cherry picked from commit fa3f2bc)

Added code comments

d0f149e

norareidy reviewed Aug 31, 2023

View reviewed changes

norareidy approved these changes Aug 31, 2023

View reviewed changes

Nora feedback

30cd055

jordan-smith721 merged commit 5b0652a into mongodb:master Sep 1, 2023

jordan-smith721 added a commit to jordan-smith721/docs-node that referenced this pull request Sep 5, 2023

Added code comments (mongodb#772)

51d546a

(cherry picked from commit 5b0652a)

jordan-smith721 added a commit that referenced this pull request Sep 5, 2023

Added code comments (#772) (#778)

4f1253c

(cherry picked from commit 5b0652a)

mongoKart pushed a commit to mongoKart/docs-node that referenced this pull request Nov 3, 2023

Added code comments (mongodb#772)

a800cc9

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added code comments #772

Added code comments #772

jordan-smith721 commented Aug 30, 2023

norareidy Aug 31, 2023

norareidy left a comment

norareidy Aug 31, 2023

norareidy Aug 31, 2023

norareidy Aug 31, 2023

norareidy Aug 31, 2023

norareidy Aug 31, 2023

norareidy Aug 31, 2023

norareidy Aug 31, 2023

norareidy Aug 31, 2023

norareidy Aug 31, 2023

norareidy Aug 31, 2023

	// Replace the following string with your MongoDB deployment's connection string.
	// Replace the following string with your MongoDB deployment's connection string

	// Create a query that searches for the specified string
	// Create a query that searches for the "trek" string

	// Create a query that searches for a specified phrase while omitting another
	// Create a query that searches for a specified phrase while omitting the "into darkness" phrase

	// Replace the following with your MongoDB deployment's connection string.
	// Replace the following with your MongoDB deployment's connection string

	// Replace the uri string with your MongoDB deployment's connection string.
	// Replace the uri string with your MongoDB deployment's connection string

		@@ -10,20 +12,22 @@ async function run() {
		const database = client.db("sample_mflix");
		const movies = database.collection("movies");

		@@ -22,6 +25,8 @@ async function run() {
		try {
		const database = client.db("sample_mflix");

Added code comments #772

Added code comments #772

Conversation

jordan-smith721 commented Aug 30, 2023

Pull Request Info

Self-Review Checklist

Choose a reason for hiding this comment

norareidy left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment