DOCSP-10956: remove the leading line in code snippets (#113)

Chris Cho · web-flow · commit ef01835c094d · 2020-06-25T14:01:21.000-04:00
* DOCSP-10956: remove the leading line and dedents in code snippets used in literalincludes
diff --git a/source/code-snippets/authentication/aws.js b/source/code-snippets/authentication/aws.js
@@ -1,4 +1,3 @@
-// ignored first line
 const { MongoClient } = require("mongodb");
 
 // Replace the following with values for your environment.
diff --git a/source/code-snippets/authentication/cr.js b/source/code-snippets/authentication/cr.js
@@ -1,4 +1,3 @@
-// ignored first line
 const { MongoClient } = require("mongodb");
 
 // Replace the following with values for your environment.
diff --git a/source/code-snippets/authentication/default.js b/source/code-snippets/authentication/default.js
@@ -1,4 +1,3 @@
-// ignored first line
 const { MongoClient } = require("mongodb");
 
 // Replace the following with values for your environment.
diff --git a/source/code-snippets/authentication/sha1.js b/source/code-snippets/authentication/sha1.js
@@ -1,4 +1,3 @@
-// ignored first line
 const { MongoClient } = require("mongodb");
 
 // Replace the following with values for your environment.
diff --git a/source/code-snippets/authentication/sha256.js b/source/code-snippets/authentication/sha256.js
@@ -1,4 +1,3 @@
-// ignored first line
 const { MongoClient } = require("mongodb");
 
 // Replace the following with values for your environment.
diff --git a/source/code-snippets/authentication/x509.js b/source/code-snippets/authentication/x509.js
@@ -1,4 +1,3 @@
-// ignored first line
 const { MongoClient } = require("mongodb");
 
 // Replace the following with values for your environment.
diff --git a/source/code-snippets/collation/aggregation-collation.js b/source/code-snippets/collation/aggregation-collation.js
@@ -1,4 +1,3 @@
-// ignored first line
 collection.aggregate(
   [
     { $group: { "_id": "$first_name", "nameCount": { "$sum": 1 } } },
diff --git a/source/code-snippets/collation/collection-collation.js b/source/code-snippets/collation/collection-collation.js
@@ -1,5 +1,3 @@
-// ignored first line
-
 // start create collection with collation
 // Create the collection with a collation
 db.createCollection("souvenirs", {
diff --git a/source/code-snippets/collation/find-sort-collation.js b/source/code-snippets/collation/find-sort-collation.js
@@ -1,3 +1,2 @@
-// ignored first line
 collection.find({ city: "New York" }, { collation: { locale: "de" } })
   .sort({ name: 1 });
diff --git a/source/code-snippets/collation/findOneAndDelete-collation.js b/source/code-snippets/collation/findOneAndDelete-collation.js
@@ -1,4 +1,3 @@
-// ignored first line
 // start findOneAndDelete example without collation
 await collection.findOneAndDelete({ a: { $gt: "100" } });
 // end findOneAndDelete example without collation
diff --git a/source/code-snippets/collation/findOneAndUpdate-collation.js b/source/code-snippets/collation/findOneAndUpdate-collation.js
@@ -1,4 +1,3 @@
-// ignored first line
 // start findOneAndUpdate without collation
 collection.findOneAndUpdate(
   { first_name : { $lt: "Gunter" } },
diff --git a/source/code-snippets/collation/index-collation.js b/source/code-snippets/collation/index-collation.js
@@ -1,4 +1,3 @@
-// ignored first line
 collection.createIndex(
   { 'title' : 1 },
-  { 'collation' : { 'locale' : 'en_US' } });
+  { 'collation' : { 'locale' : 'en_US' } });
diff --git a/source/code-snippets/collation/query-index-collation.js b/source/code-snippets/collation/query-index-collation.js
@@ -1,4 +1,3 @@
-// ignored first line
 // start query index collation
 collection.find({"year": 1980}, {"collation" : {"locale" : "en_US" }})
   .sort({"title": -1});
diff --git a/source/code-snippets/crud/arrayFilters.js b/source/code-snippets/crud/arrayFilters.js
@@ -1,4 +1,3 @@
-// ignored first line
 const { MongoClient } = require("mongodb");
 const stream = require("stream");
 
diff --git a/source/code-snippets/crud/cursor.js b/source/code-snippets/crud/cursor.js
@@ -1,4 +1,3 @@
-// ignored first line
 const { MongoClient } = require("mongodb");
 const stream = require("stream");
 
diff --git a/source/code-snippets/crud/pizza.js b/source/code-snippets/crud/pizza.js
@@ -1,4 +1,3 @@
-// ignored first line
 const { MongoClient } = require("mongodb");
 
 // Replace the following string with your MongoDB deployment's connection string.
diff --git a/source/code-snippets/crud/startrek.js b/source/code-snippets/crud/startrek.js
@@ -1,4 +1,3 @@
-// ignored first line
 const { MongoClient } = require("mongodb");
 
 // Replace the following string with your MongoDB deployment's connection string.
diff --git a/source/code-snippets/crud/theaters.js b/source/code-snippets/crud/theaters.js
@@ -1,4 +1,3 @@
-// ignored first line
 const { MongoClient } = require("mongodb");
 
 // Replace the following string with your MongoDB deployment's connection string.
diff --git a/source/code-snippets/faq/econnresetWithClientConnect-example.js b/source/code-snippets/faq/econnresetWithClientConnect-example.js
@@ -1,4 +1,3 @@
-// ignored first line
 const uri = "mongodb://localhost:27017/test?maxPoolSize=5000";
 // create a new MongoClient
 const client = new MongoClient(uri);
diff --git a/source/code-snippets/logging/levels.js b/source/code-snippets/logging/levels.js
@@ -1,4 +1,3 @@
-// ignored first line
 // begin-ex
 const { MongoClient, Logger } = require("mongodb");
 
diff --git a/source/code-snippets/monitoring/subscribe.js b/source/code-snippets/monitoring/subscribe.js
@@ -1,4 +1,3 @@
-// ignored first line
 const { MongoClient } = require("mongodb");
 
 // Replace the following with your MongoDB deployment's connection
diff --git a/source/code-snippets/usage-examples/bulkWrite.js b/source/code-snippets/usage-examples/bulkWrite.js
@@ -1,4 +1,3 @@
-
 const { MongoClient } = require("mongodb");
 
 // Replace the uri string with your MongoDB deployment's connection string.
diff --git a/source/code-snippets/usage-examples/changeStream.js b/source/code-snippets/usage-examples/changeStream.js
@@ -1,4 +1,3 @@
-// ignored first line
 const { MongoClient } = require("mongodb");
 
 // Replace the uri string with your MongoDB deployment's connection string.
diff --git a/source/code-snippets/usage-examples/command.js b/source/code-snippets/usage-examples/command.js
@@ -1,4 +1,3 @@
-// ignored first line
 const { MongoClient } = require("mongodb");
 
 // Replace the uri string with your MongoDB deployment's connection string.
diff --git a/source/code-snippets/usage-examples/count.js b/source/code-snippets/usage-examples/count.js
@@ -1,4 +1,3 @@
-// ignored first line
 const { MongoClient } = require("mongodb");
 
 // Replace the uri string with your MongoDB deployment's connection string.
diff --git a/source/code-snippets/usage-examples/deleteMany.js b/source/code-snippets/usage-examples/deleteMany.js
@@ -1,4 +1,3 @@
-// ignored first line
 const { MongoClient } = require("mongodb");
 
 // Replace the uri string with your MongoDB deployment's connection string.
diff --git a/source/code-snippets/usage-examples/deleteOne.js b/source/code-snippets/usage-examples/deleteOne.js
@@ -1,4 +1,3 @@
-// ignored first line
 const { MongoClient } = require("mongodb");
 
 // Replace the uri string with your MongoDB deployment's connection string.
diff --git a/source/code-snippets/usage-examples/distinct.js b/source/code-snippets/usage-examples/distinct.js
@@ -1,4 +1,3 @@
-// ignored first line
 const { MongoClient } = require("mongodb");
 
 // Replace the uri string with your MongoDB deployment's connection string.
diff --git a/source/code-snippets/usage-examples/find.js b/source/code-snippets/usage-examples/find.js
@@ -1,4 +1,3 @@
-// ignored first line
 const { MongoClient } = require("mongodb");
 
 // Replace the uri string with your MongoDB deployment's connection string.
diff --git a/source/code-snippets/usage-examples/findOne.js b/source/code-snippets/usage-examples/findOne.js
@@ -1,4 +1,3 @@
-// ignored first line
 const { MongoClient } = require("mongodb");
 
 // Replace the uri string with your MongoDB deployment's connection string.
diff --git a/source/code-snippets/usage-examples/insertMany.js b/source/code-snippets/usage-examples/insertMany.js
@@ -1,4 +1,3 @@
-// ignored first line
 const { MongoClient } = require("mongodb");
 
 // Replace the uri string with your MongoDB deployment's connection string.
diff --git a/source/code-snippets/usage-examples/insertOne.js b/source/code-snippets/usage-examples/insertOne.js
@@ -1,4 +1,3 @@
-// ignored first line
 const { MongoClient } = require("mongodb");
 
 // Replace the uri string with your MongoDB deployment's connection string.
diff --git a/source/code-snippets/usage-examples/replaceOne.js b/source/code-snippets/usage-examples/replaceOne.js
@@ -1,4 +1,3 @@
-// ignored first line
 const { MongoClient } = require("mongodb");
 
 // Replace the uri string with your MongoDB deployment's connection string.
diff --git a/source/code-snippets/usage-examples/updateMany.js b/source/code-snippets/usage-examples/updateMany.js
@@ -1,4 +1,3 @@
-// ignored first line
 const { MongoClient } = require("mongodb");
 
 // Replace the uri string with your MongoDB deployment's connection string.
diff --git a/source/code-snippets/usage-examples/updateOne.js b/source/code-snippets/usage-examples/updateOne.js
@@ -1,4 +1,3 @@
-// ignored first line
 const { MongoClient } = require("mongodb");
 
 // Replace the uri string with your MongoDB deployment's connection string.
diff --git a/source/fundamentals/authentication/mechanisms.txt b/source/fundamentals/authentication/mechanisms.txt
@@ -43,7 +43,6 @@ password as shown in the code below.
 
 .. literalinclude:: /code-snippets/authentication/default.js
    :language: javascript
-   :dedent: 4
 
 For more information on the challenge-response (CR) and salted
 challenge-response authentication mechanisms (SCRAM) that MongoDB supports,
@@ -72,7 +71,6 @@ following sample code.
 
 .. literalinclude:: /code-snippets/authentication/sha256.js
    :language: javascript
-   :dedent: 4
 
 ``SCRAM-SHA-1``
 ---------------
@@ -96,7 +94,6 @@ in the following sample code.
 
 .. literalinclude:: /code-snippets/authentication/sha1.js
    :language: javascript
-   :dedent: 4
 
 ``MONGODB-CR``
 --------------
@@ -118,7 +115,6 @@ in the following sample code.
 
 .. literalinclude:: /code-snippets/authentication/cr.js
    :language: javascript
-   :dedent: 4
 
 .. important::
    If you have :manual:`upgraded the authentication schema from MONGODB-CR to
@@ -156,7 +152,6 @@ authentication mechanism and credentials in the connection string.
 
 .. literalinclude:: /code-snippets/authentication/aws.js
    :language: javascript
-   :dedent: 4
 
 
 ``X.509``
@@ -189,7 +184,6 @@ Pass the location of your client certificate file as the value of
 
 .. literalinclude:: /code-snippets/authentication/x509.js
    :language: javascript
-   :dedent: 4
 
 TLS/SSL Options
 ~~~~~~~~~~~~~~~
diff --git a/source/fundamentals/collations.txt b/source/fundamentals/collations.txt
@@ -120,7 +120,6 @@ collection.
    :language: javascript
    :start-after: start create collection with collation
    :end-before: end create collection with collation
-   :dedent: 4
 
 Any of the operations that support collations automatically apply the collation
 defined on the collection. The query below searches the ``souvenirs``
@@ -130,7 +129,6 @@ collection and applies the "``fr_CA``" locale collation:
    :language: javascript
    :start-after: start collection query without collation
    :end-before: end collection query without collation
-   :dedent: 4
 
 You can specify a different collation as a parameter in an operation that
 supports collations. The following query specifies the "``is``" Iceland locale
@@ -140,7 +138,6 @@ and ``caseFirst`` optional parameter with the value "``upper``":
    :language: javascript
    :start-after: start collection query with collation
    :end-before: end collection query with collation
-   :dedent: 4
 
 Assign a Collation to an Index
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -150,15 +147,13 @@ a collection with a collation set to the "``en_US``" locale.
 
 .. literalinclude:: /code-snippets/collation/index-collation.js
    :language: javascript
-   :dedent: 4
 
 The following query uses the index we created:
 
 .. literalinclude:: /code-snippets/collation/query-index-collation.js
    :language: javascript
    :start-after: start query index collation
    :end-before: end query index collation
-   :dedent: 4
 
 The following queries **do not** use the index that we created.  The first
 query does not include a collation and the second contains a different
@@ -168,7 +163,6 @@ strength value than the collation on the index.
    :language: javascript
    :start-after: start query without index collation
    :end-before: end query without index collation
-   :dedent: 4
 
 Collation Query Examples
 ~~~~~~~~~~~~~~~~~~~~~~~~
@@ -187,7 +181,6 @@ setting the value of the ``locale`` parameter to ``de``.
 
 .. literalinclude:: /code-snippets/collation/find-sort-collation.js
    :language: javascript
-   :dedent: 4
 
 findOneAndUpdate() Example
 ``````````````````````````
@@ -210,7 +203,6 @@ which **does not** specify a collation:
    :language: javascript
    :start-after: start findOneAndUpdate without collation
    :end-before: end findOneAndUpdate without collation
-   :dedent: 4
 
 Since "Gunter" is the first sorted result when using a binary collation, none
 of the documents come lexically before and match the ``$lt`` comparison
@@ -228,7 +220,6 @@ umlauts.
    :language: javascript
    :start-after: start findOneAndUpdate with collation
    :end-before: end findOneAndUpdate with collation
-   :dedent: 4
 
 Since "Günter" lexically comes before "Gunter" using the
 ``de@collation=phonebook`` collation specified in ``findOneAndUpdate()``,
@@ -261,7 +252,6 @@ lexical order.
    :language: javascript
    :start-after: start findOneAndDelete example with collation
    :end-before: end findOneAndDelete example with collation
-   :dedent: 4
 
 After you run the operation above, the collection contains the following
 documents:
@@ -280,7 +270,6 @@ document it finds that matches the query criteria.
    :language: javascript
    :start-after: start findOneAndDelete example without collation
    :end-before: end findOneAndDelete example without collation
-   :dedent: 4
 
 Since all the documents contain lexical values in the ``a`` field that
 match the criteria (greater than the lexical value of "``100``"), the operation
@@ -310,4 +299,3 @@ the German phonebook (``de@collation=phonebook`` locale) order.
 
 .. literalinclude:: /code-snippets/collation/aggregation-collation.js
    :language: javascript
-   :dedent: 4
diff --git a/source/fundamentals/connection.txt b/source/fundamentals/connection.txt
@@ -52,7 +52,6 @@ connect to MongoDB.
 
 .. literalinclude:: /code-snippets/connection/srv.js
    :language: javascript
-   :dedent: 4
 
 ------------------------
 Connect to a Replica Set
diff --git a/source/fundamentals/crud/read-operations/cursor.txt b/source/fundamentals/crud/read-operations/cursor.txt
@@ -69,7 +69,6 @@ results in a functional style:
    :language: javascript
    :start-after: start foreach cursor example
    :end-before: end foreach cursor example
-   :dedent: 4
 
 Asynchronous Iteration
 ~~~~~~~~~~~~~~~~~~~~~~
@@ -82,7 +81,6 @@ allows you to use cursors in ``for``...``await`` loops:
    :language: javascript
    :start-after: start async cursor example
    :end-before: end async cursor example
-   :dedent: 4
 
 Manual Iteration
 ~~~~~~~~~~~~~~~~
@@ -96,7 +94,6 @@ method to retrieve the subsequent element of the cursor:
    :language: javascript
    :start-after: start manual cursor example
    :end-before: end manual cursor example
-   :dedent: 4
 
 Stream API
 ~~~~~~~~~~
@@ -109,7 +106,6 @@ pipeline. Cursors work with most Node stream APIs:
    :language: javascript
    :start-after: start stream cursor example
    :end-before: end stream cursor example
-   :dedent: 4
 
 Event API
 ~~~~~~~~~
@@ -121,7 +117,6 @@ As Readable Streams, cursors also support the Event API's
    :language: javascript
    :start-after: start event cursor example
    :end-before: end event cursor example
-   :dedent: 4
 
 Fetch All Documents At Once
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -136,7 +131,6 @@ exceeding memory constraints.
    :language: javascript
    :start-after: start fetchAll cursor example
    :end-before: end fetchAll cursor example
-   :dedent: 4
 
 
 Cursor Utility Methods
@@ -152,7 +146,6 @@ cursor, use :node-api:`count() <Cursor.html#count>`:
    :language: javascript
    :start-after: start count cursor example
    :end-before: end count cursor example
-   :dedent: 4
 
 Rewind
 ~~~~~~
@@ -164,7 +157,6 @@ documents, use :node-api:`rewind() <Cursor.html#rewind>`.
    :language: javascript
    :start-after: start rewind cursor example
    :end-before: end rewind cursor example
-   :dedent: 4
 
 Close
 ~~~~~
@@ -179,4 +171,3 @@ and the MongoDB server:
    :language: javascript
    :start-after: start close cursor example
    :end-before: end close cursor example
-   :dedent: 4
diff --git a/source/fundamentals/crud/read-operations/geo.txt b/source/fundamentals/crud/read-operations/geo.txt
diff --git a/source/fundamentals/crud/read-operations/retrieve.txt b/source/fundamentals/crud/read-operations/retrieve.txt
diff --git a/source/fundamentals/crud/read-operations/text.txt b/source/fundamentals/crud/read-operations/text.txt
diff --git a/source/fundamentals/crud/write-operations/embedded-arrays.txt b/source/fundamentals/crud/write-operations/embedded-arrays.txt
diff --git a/source/fundamentals/logging.txt b/source/fundamentals/logging.txt
diff --git a/source/fundamentals/monitoring.txt b/source/fundamentals/monitoring.txt
diff --git a/source/usage-examples/find.txt b/source/usage-examples/find.txt
diff --git a/source/usage-examples/findOne.txt b/source/usage-examples/findOne.txt

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`		`-// ignored first line`
`2`	`1`	`const { MongoClient } = require("mongodb");`
`3`	`2`
`4`	`3`	`// Replace the following with values for your environment.`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`		`-// ignored first line`
`2`	`1`	`collection.aggregate(`
`3`	`2`	`[`
`4`	`3`	`{ $group: { "_id": "$first_name", "nameCount": { "$sum": 1 } } },`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,3 @@`
`1`		`-// ignored first line`
`2`		`-`
`3`	`1`	`// start create collection with collation`
`4`	`2`	`// Create the collection with a collation`
`5`	`3`	`db.createCollection("souvenirs", {`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,2 @@`
`1`		`-// ignored first line`
`2`	`1`	`collection.find({ city: "New York" }, { collation: { locale: "de" } })`
`3`	`2`	`.sort({ name: 1 });`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`		`-// ignored first line`
`2`	`1`	`// start findOneAndDelete example without collation`
`3`	`2`	`await collection.findOneAndDelete({ a: { $gt: "100" } });`
`4`	`3`	`// end findOneAndDelete example without collation`