Skip to content

Commit 297d843

Browse files
committedJul 9, 2018
docs(sessions): updating docs for sessions
Pulling in updated core docs for sessions
1 parent 15dc808 commit 297d843

File tree

3 files changed

+21
-21
lines changed

3 files changed

+21
-21
lines changed
 

‎conf.json

+2
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@
2222
"lib/topologies/server.js",
2323
"node_modules/mongodb-core/lib/error.js",
2424
"node_modules/mongodb-core/lib/connection/logger.js",
25+
"node_modules/mongodb-core/lib/sessions.js",
26+
"node_modules/mongodb-core/lib/transactions.js",
2527
"node_modules/bson/lib/bson/binary.js",
2628
"node_modules/bson/lib/bson/code.js",
2729
"node_modules/bson/lib/bson/db_ref.js",

‎docs/jsdoc-template/tmpl/container.tmpl

+18-16
Original file line numberDiff line numberDiff line change
@@ -25,26 +25,28 @@
2525
</header>
2626

2727
<article>
28-
<div class="container-overview">
29-
<?js if (doc.kind === 'module' && doc.module) { ?>
30-
<?js= self.partial('method.tmpl', doc.module) ?>
31-
<?js } ?>
32-
33-
<?js if (doc.kind === 'class') { ?>
34-
<?js= self.partial('method.tmpl', doc) ?>
35-
<?js } else { ?>
36-
<?js if (doc.description) { ?>
37-
<div class="description"><?js= doc.description ?></div>
28+
<?js if (!doc.hideconstructor) { ?>
29+
<div class="container-overview">
30+
<?js if (doc.kind === 'module' && doc.module) { ?>
31+
<?js= self.partial('method.tmpl', doc.module) ?>
3832
<?js } ?>
3933

40-
<?js= self.partial('details.tmpl', doc) ?>
41-
42-
<?js if (doc.examples && doc.examples.length) { ?>
43-
<h3>Example<?js= doc.examples.length > 1? 's':'' ?></h3>
44-
<?js= self.partial('examples.tmpl', doc.examples) ?>
34+
<?js if (doc.kind === 'class') { ?>
35+
<?js= self.partial('method.tmpl', doc) ?>
36+
<?js } else { ?>
37+
<?js if (doc.description) { ?>
38+
<div class="description"><?js= doc.description ?></div>
39+
<?js } ?>
40+
41+
<?js= self.partial('details.tmpl', doc) ?>
42+
43+
<?js if (doc.examples && doc.examples.length) { ?>
44+
<h3>Example<?js= doc.examples.length > 1? 's':'' ?></h3>
45+
<?js= self.partial('examples.tmpl', doc.examples) ?>
46+
<?js } ?>
4547
<?js } ?>
48+
</div>
4649
<?js } ?>
47-
</div>
4850

4951
<?js if (doc.augments && doc.augments.length) { ?>
5052
<h3 class="subsection-title">Extends</h3>

‎lib/mongo_client.js

+1-5
Original file line numberDiff line numberDiff line change
@@ -374,11 +374,7 @@ MongoClient.connect = function(url, options, callback) {
374374
/**
375375
* Starts a new session on the server
376376
*
377-
* @param {object} [options] optional settings for a driver session
378-
* @param {boolean} [options.causalConsistency] Indicate that this session should be causally consistent.
379-
* @param {boolean} [options.autoStartTransaction=false] When enabled this session automatically starts a transaction with the provided defaultTransactionOptions.
380-
* @param {object} [options.defaultTransactionOptions] The default TransactionOptions to use for transactions started on this session.
381-
*
377+
* @param {SessionOptions} [options] optional settings for a driver session
382378
* @return {ClientSession} the newly established session
383379
*/
384380
MongoClient.prototype.startSession = function(options) {

0 commit comments

Comments
 (0)
Please sign in to comment.