docs(sessions): updating docs for sessions

Pulling in updated core docs for sessions
mongodb · Jul 9, 2018 · 297d843 · 297d843
1 parent 15dc808
commit 297d843
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 21 deletions.
diff --git a/conf.json b/conf.json
@@ -22,6 +22,8 @@
       "lib/topologies/server.js",
       "node_modules/mongodb-core/lib/error.js",
       "node_modules/mongodb-core/lib/connection/logger.js",
+      "node_modules/mongodb-core/lib/sessions.js",
+      "node_modules/mongodb-core/lib/transactions.js",
       "node_modules/bson/lib/bson/binary.js",
       "node_modules/bson/lib/bson/code.js",
       "node_modules/bson/lib/bson/db_ref.js",

diff --git a/docs/jsdoc-template/tmpl/container.tmpl b/docs/jsdoc-template/tmpl/container.tmpl
@@ -25,26 +25,28 @@
 </header>  
 
 <article>
-    <div class="container-overview">
-    <?js if (doc.kind === 'module' && doc.module) { ?>
-        <?js= self.partial('method.tmpl', doc.module) ?>
-    <?js } ?>
-
-    <?js if (doc.kind === 'class') { ?>
-        <?js= self.partial('method.tmpl', doc) ?>
-    <?js } else { ?>
-        <?js if (doc.description) { ?>
-            <div class="description"><?js= doc.description ?></div>
+    <?js if (!doc.hideconstructor) { ?>
+        <div class="container-overview">
+        <?js if (doc.kind === 'module' && doc.module) { ?>
+            <?js= self.partial('method.tmpl', doc.module) ?>
         <?js } ?>
 
-        <?js= self.partial('details.tmpl', doc) ?>
-
-        <?js if (doc.examples && doc.examples.length) { ?>
-            <h3>Example<?js= doc.examples.length > 1? 's':'' ?></h3>
-            <?js= self.partial('examples.tmpl', doc.examples) ?>
+        <?js if (doc.kind === 'class') { ?>
+            <?js= self.partial('method.tmpl', doc) ?>
+        <?js } else { ?>
+            <?js if (doc.description) { ?>
+                <div class="description"><?js= doc.description ?></div>
+            <?js } ?>
+
+            <?js= self.partial('details.tmpl', doc) ?>
+
+            <?js if (doc.examples && doc.examples.length) { ?>
+                <h3>Example<?js= doc.examples.length > 1? 's':'' ?></h3>
+                <?js= self.partial('examples.tmpl', doc.examples) ?>
+            <?js } ?>
         <?js } ?>
+        </div>
     <?js } ?>
-    </div>
 
     <?js if (doc.augments && doc.augments.length) { ?>
         <h3 class="subsection-title">Extends</h3>

diff --git a/lib/mongo_client.js b/lib/mongo_client.js
@@ -374,11 +374,7 @@ MongoClient.connect = function(url, options, callback) {
 /**
  * Starts a new session on the server
  *
- * @param {object} [options] optional settings for a driver session
- * @param {boolean} [options.causalConsistency] Indicate that this session should be causally consistent.
- * @param {boolean} [options.autoStartTransaction=false] When enabled this session automatically starts a transaction with the provided defaultTransactionOptions.
- * @param {object} [options.defaultTransactionOptions] The default TransactionOptions to use for transactions started on this session.
- *
+ * @param {SessionOptions} [options] optional settings for a driver session
  * @return {ClientSession} the newly established session
  */
 MongoClient.prototype.startSession = function(options) {