Skip to content

Commit 64c02d0

Browse files
committed
Fix documentation issues called out by sphinx
1 parent 16e8f19 commit 64c02d0

File tree

1 file changed

+14
-13
lines changed

1 file changed

+14
-13
lines changed

source/tutorials/ruby-driver-create-client.txt

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -960,7 +960,7 @@ a server. Defaults to 10.
960960
This timeout is also used as both connect timeout and socket timeout for
961961
monitoring connections.
962962

963-
When using a ``mongodb+srv://` URI, this timeout is also used for SRV and TXT
963+
When using a ``mongodb+srv://`` URI, this timeout is also used for SRV and TXT
964964
DNS lookups. Note that the timeout applies per lookup; due to DNS suffix search
965965
lists, multiple lookups may be performed as part of a single name resolution.
966966

@@ -1113,14 +1113,15 @@ that both of the following fields are set in the intermediate certificate(s):
11131113
- X509v3 Basic Constraints: CA: TRUE -- Can sign certificates
11141114
- X509v3 Key Usage: Key Cert Sign -- Can sign certificates
11151115

1116-
More information about these flags can be found `here
1116+
More information about these flags can be found `in this Stack Overflow question
11171117
<https://stackoverflow.com/questions/5795256/what-is-the-difference-between-the-x-509-v3-extensions-basic-constraints-and-key>`_.
11181118

11191119
It is a common pitfall to concatenate intermediate certificates to the root
11201120
CA certificates passed in ``tlsCAFile`` / ``ssl_ca_cert`` options. By doing
11211121
so, the intermediate certificates are elevated to trusted status and are
11221122
themselves not verified against the actual CA root. More information on this
1123-
issue is available `here <https://mail.python.org/pipermail/cryptography-dev/2016-August/000676.html>`_.
1123+
issue is available `in this mailing list post
1124+
<https://mail.python.org/pipermail/cryptography-dev/2016-August/000676.html>`_.
11241125

11251126
Specify CA Certificate
11261127
----------------------
@@ -1348,7 +1349,7 @@ and cease background monitoring:
13481349
parent remains alive.
13491350

13501351
Reconnecting Client Instances
1351-
`````````````````````````````
1352+
-----------------------------
13521353

13531354
When the Ruby driver is used in a web application, it is recommended to not
13541355
create any ``Mongo::Client`` instances in the management processes (prior to
@@ -1398,7 +1399,7 @@ however provides examples for closing clients in the parent process and
13981399
reconnecting clients in the child processes.
13991400

14001401
Troubleshooting
1401-
```````````````
1402+
---------------
14021403

14031404
The client's ``summary`` method returns the current state of the client,
14041405
including servers that the client is monitoring and their state. If any of
@@ -1439,7 +1440,7 @@ As of driver version 2.9.0, the modern mechanism is used by default, and the
14391440
legacy mechanism is deprecated.
14401441

14411442
Modern Retryable Reads
1442-
``````````````````````
1443+
----------------------
14431444

14441445
When the modern mechanism is used, read operations are retried once in the
14451446
event of a network error, a "not master" error, or a "node is recovering" error.
@@ -1478,7 +1479,7 @@ must explicitly request legacy retryable reads by setting the
14781479
``retry_reads: false`` client option or using ``retryReads=false`` URI option.
14791480

14801481
Legacy Retryable Reads
1481-
``````````````````````
1482+
----------------------
14821483

14831484
The legacy read retry behavior of the Ruby driver is available by setting the
14841485
``retry_reads: false`` client option or passing the ``retryReads=false`` URI
@@ -1497,7 +1498,7 @@ versions read retries would be sent to the same server which the initial read
14971498
was sent to.
14981499

14991500
Disabling Retryable Reads
1500-
`````````````````````````
1501+
-------------------------
15011502

15021503
To disable all read retries, set the following client options:
15031504
``retry_reads: false, max_read_retries: 0``.
@@ -1524,7 +1525,7 @@ are subject to write retries:
15241525
- ``collection#bulk_write`` (for all single statement ops, i.e. not for ``update_many`` or ``delete_many``)
15251526

15261527
Modern Retryable Writes
1527-
```````````````````````
1528+
-----------------------
15281529

15291530
The modern mechanism will retry failing writes once when the driver is
15301531
connected to a MongoDB 3.6 or higher replica set or a sharded cluster,
@@ -1543,7 +1544,7 @@ since the server that the original write was sent to is likely no longer
15431544
usable.
15441545

15451546
Legacy Retryable Writes
1546-
```````````````````````
1547+
-----------------------
15471548

15481549
If modern retryable writes mechanism is disabled by setting the client
15491550
option ``retry_writes: false`` or by using the ``retryWrites=false``
@@ -1559,7 +1560,7 @@ of errors compared to the modern mechanism, and specifically does not
15591560
retry writes when a network timeout is encountered.
15601561

15611562
Disabling Retryable Writes
1562-
``````````````````````````
1563+
--------------------------
15631564

15641565
To disable all write retries, set the following client options:
15651566
``retry_writes: false, max_write_retries: 0``.
@@ -1577,7 +1578,7 @@ See the `Ruby Logger documentation <http://ruby-doc.org/stdlib-2.2.0/libdoc/logg
15771578
for more information on the default logger API and available levels.
15781579

15791580
Changing the Logger Level
1580-
`````````````````````````
1581+
-------------------------
15811582

15821583
To change the logger level:
15831584

@@ -1593,7 +1594,7 @@ For more control, a logger can be passed to a client for per-client control over
15931594
Mongo::Client.new([ '127.0.0.1:27017' ], :database => 'test', :logger => my_logger )
15941595

15951596
Truncation
1596-
``````````
1597+
----------
15971598

15981599
The default logging truncates logs at 250 characters by default. To turn this off pass an
15991600
option to the client instance.

0 commit comments

Comments
 (0)