Skip to content

Commit 09f2b42

Browse files
committed
CDRIVER-1979 simpler RST markup
Now :symbol:`function()` and :symbol:`function` work the same, but let you choose whether to include parentheses.
1 parent 0d8383f commit 09f2b42

File tree

413 files changed

+1023
-1017
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

413 files changed

+1023
-1017
lines changed

doc/application-performance-monitoring.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ The MongoDB C Driver allows you to monitor all the MongoDB operations the driver
88
* `Command Monitoring <https://github.com/mongodb/specifications/blob/master/source/command-monitoring/command-monitoring.rst>`_: events related to all application operations.
99
* `SDAM Monitoring <https://github.com/mongodb/specifications/blob/master/source/server-discovery-and-monitoring/server-discovery-and-monitoring-monitoring.rst>`_: events related to the driver's Server Discovery And Monitoring logic.
1010

11-
To receive notifications, create a ``mongoc_apm_callbacks_t`` with :symbol:`mongoc_apm_callbacks_new <mongoc_apm_callbacks_new>`, set callbacks on it, then pass it to :symbol:`mongoc_client_set_apm_callbacks <mongoc_client_set_apm_callbacks>` or :symbol:`mongoc_client_pool_set_apm_callbacks <mongoc_client_pool_set_apm_callbacks>`.
11+
To receive notifications, create a ``mongoc_apm_callbacks_t`` with :symbol:`mongoc_apm_callbacks_new`, set callbacks on it, then pass it to :symbol:`mongoc_client_set_apm_callbacks` or :symbol:`mongoc_client_pool_set_apm_callbacks`.
1212

1313
Command-Monitoring Example
1414
--------------------------

doc/bulk.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ This tutorial explains how to take advantage of MongoDB C driver bulk write oper
88
Bulk Insert
99
-----------
1010

11-
First we need to fetch a bulk operation handle from the :symbol:`mongoc_collection_t <mongoc_collection_t>`. This can be performed in either ordered or unordered mode. Unordered mode allows for greater parallelization when working with sharded clusters.
11+
First we need to fetch a bulk operation handle from the :symbol:`mongoc_collection_t`. This can be performed in either ordered or unordered mode. Unordered mode allows for greater parallelization when working with sharded clusters.
1212

1313
.. code-block:: c
1414
@@ -17,13 +17,13 @@ First we need to fetch a bulk operation handle from the :symbol:`mongoc_collecti
1717
1818
We can now start inserting documents to the bulk operation. These will be buffered until we execute the operation.
1919

20-
The bulk operation will coalesce insertions as a single batch for each consecutive call to :symbol:`mongoc_bulk_operation_insert() <mongoc_bulk_operation_insert>`. This creates a pipelined effect when possible.
20+
The bulk operation will coalesce insertions as a single batch for each consecutive call to :symbol:`mongoc_bulk_operation_insert()`. This creates a pipelined effect when possible.
2121

2222
.. tip::
2323

2424
The bulk operation API will automatically handle MongoDB servers < 2.6 by speaking the old wire protocol. However, some performance degradation may occur.
2525

26-
To execute the bulk operation and receive the result we call :symbol:`mongoc_bulk_operation_execute() <mongoc_bulk_operation_execute>`.
26+
To execute the bulk operation and receive the result we call :symbol:`mongoc_bulk_operation_execute()`.
2727

2828
.. literalinclude:: ../examples/bulk/bulk1.c
2929
:language: c
@@ -48,7 +48,7 @@ MongoDB C driver also supports executing mixed bulk write operations. A batch of
4848

4949
.. tip::
5050

51-
Though the following API will work with all versions of MongoDB, it is designed to be used with MongoDB versions >= 2.6. Much better bulk insert performance can be achieved with older versions of MongoDB through the deprecated :symbol:`mongoc_collection_insert_bulk() <mongoc_collection_insert_bulk>` method.
51+
Though the following API will work with all versions of MongoDB, it is designed to be used with MongoDB versions >= 2.6. Much better bulk insert performance can be achieved with older versions of MongoDB through the deprecated :symbol:`mongoc_collection_insert_bulk()` method.
5252

5353
Ordered Bulk Write Operations
5454
-----------------------------
@@ -150,7 +150,7 @@ The :symbol:`bson_error_t <errors>` domain is ``MONGOC_ERROR_COMMAND``.
150150
Bulk Operation Write Concerns
151151
-----------------------------
152152

153-
By default bulk operations are executed with the :symbol:`write_concern <mongoc_write_concern_t>` of the collection they are executed against. A custom write concern can be passed to the :symbol:`mongoc_collection_create_bulk_operation() <mongoc_collection_create_bulk_operation>` method. Write concern errors (e.g. wtimeout) will be reported after all operations are attempted, regardless of execution order.
153+
By default bulk operations are executed with the :symbol:`write_concern <mongoc_write_concern_t>` of the collection they are executed against. A custom write concern can be passed to the :symbol:`mongoc_collection_create_bulk_operation()` method. Write concern errors (e.g. wtimeout) will be reported after all operations are attempted, regardless of execution order.
154154

155155
.. literalinclude:: ../examples/bulk/bulk4.c
156156
:language: c

doc/cursors.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,14 +39,14 @@ While iterating cursors, you should check to see if an error has occurred. See t
3939
Destroying Server-Side Cursors
4040
------------------------------
4141

42-
The MongoDB C driver will automatically destroy a server-side cursor when :symbol:`mongoc_cursor_destroy() <mongoc_cursor_destroy>` is called. Failure to call this function when done with a cursor will leak memory client side as well as consume extra memory server side. If the cursor was configured to never timeout, it will become a memory leak on the server.
42+
The MongoDB C driver will automatically destroy a server-side cursor when :symbol:`mongoc_cursor_destroy()` is called. Failure to call this function when done with a cursor will leak memory client side as well as consume extra memory server side. If the cursor was configured to never timeout, it will become a memory leak on the server.
4343

4444
.. _cursors_tailable:
4545

4646
Tailable Cursors
4747
----------------
4848

49-
Tailable cursors are cursors that remain open even after they've returned a final result. This way, if more documents are added to a collection (i.e., to the cursor's result set), then you can continue to call :symbol:`mongoc_cursor_next() <mongoc_cursor_next>` to retrieve those additional results.
49+
Tailable cursors are cursors that remain open even after they've returned a final result. This way, if more documents are added to a collection (i.e., to the cursor's result set), then you can continue to call :symbol:`mongoc_cursor_next()` to retrieve those additional results.
5050

5151
Here's a complete test case that demonstrates the use of tailable cursors.
5252

@@ -68,5 +68,5 @@ Let's compile and run this example against a replica set to see updates as they
6868
6969
The line of output is a sample from performing ``db.test.insert({})`` from the mongo shell on the given replicaSet.
7070

71-
See also :symbol:`mongoc_cursor_set_max_await_time_ms <mongoc_cursor_set_max_await_time_ms>`.
71+
See also :symbol:`mongoc_cursor_set_max_await_time_ms`.
7272

0 commit comments

Comments
 (0)