Skip to content

Commit

Permalink
resolve TODOs
Browse files Browse the repository at this point in the history
  • Loading branch information
norareidy committed Aug 2, 2024
1 parent 3c3aa9d commit 0b6d8c9
Show file tree
Hide file tree
Showing 6 changed files with 15 additions and 17 deletions.
3 changes: 2 additions & 1 deletion source/get-started/create-a-connection-string.txt
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@ The connection string includes the hostname or IP address and
port of your deployment, the authentication mechanism, user credentials
when applicable, and connection options.

.. TODO: link to instructions on connecting to local deployment in Connection guide
To connect to an instance or deployment not hosted on Atlas, see the
:ref:`cpp-connection-targets` guide.

.. procedure::
:style: connected
Expand Down
5 changes: 1 addition & 4 deletions source/polyfill-selection.txt
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,4 @@ selection behavior.

.. warning::

The choice of polyfill library has a direct impact on the public API and ABI for the mongocxx library. Changing the polyfill can lead to both source-breaking changes (during compilation) and binary-breaking changes (during linking or execution). To limit reliance on polyfill-specific configuration or behavior, avoid using ``stdx::string_view`` and ``stdx::optional<T>`` with non-mongocxx library interfaces.

.. button:: Next: Download and Install
:uri: /get-started/download-and-install/
The choice of polyfill library has a direct impact on the public API and ABI for the mongocxx library. Changing the polyfill can lead to both source-breaking changes (during compilation) and binary-breaking changes (during linking or execution). To limit reliance on polyfill-specific configuration or behavior, avoid using ``stdx::string_view`` and ``stdx::optional<T>`` with non-mongocxx library interfaces.
15 changes: 8 additions & 7 deletions source/read/retrieve.txt
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,9 @@ These methods take a **query filter** and return one or more matching documents.
A query filter is an object that specifies the documents you want to retrieve in
your query.

.. TODO:
To learn more about query filters, see :ref:`cpp-specify-query`.
.. tip::

To learn more about query filters, see :ref:`cpp-specify-query`.

.. _cpp-retrieve-find-one:

Expand Down Expand Up @@ -100,8 +101,8 @@ the ``name`` field has the value ``"LinkedIn"``:
:manual:`natural order </reference/glossary/#std-term-natural-order>`
on disk if no sort criteria is specified.

.. TODO:
To learn more about sorting, see the :ref:`sort guide <cpp-sort>`.
To learn more about sorting, see the :ref:`cpp-return-documents-sort`
section of the Specify Documents to Return guide.

.. _cpp-retrieve-find-multiple:

Expand Down Expand Up @@ -220,9 +221,9 @@ For a full list of ``mongocxx::options::find`` object fields, see the
Additional Information
----------------------

.. TODO:
To learn more about query filters, see :ref:`cpp-specify-query`.
For runnable code examples of retrieving documents with {+driver-short+}, see :ref:`cpp-read`.
To learn more about query filters, see :ref:`cpp-specify-query`.

For runnable code examples of retrieving documents with the {+driver-short+}, see :ref:`cpp-read`.

For more examples that use the ``find()`` and ``find_one()`` methods, see the :ref:`cpp-tutorial-find`
section of the Tutorial page.
Expand Down
2 changes: 1 addition & 1 deletion source/security/authentication.txt
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ You can set these options in the connection string when creating a
:start-after: // start-x509
:end-before: // end-x509

.. TODO: To learn more about enabling TLS, see :ref:`cpp-tls`.
To learn more about enabling TLS, see :ref:`cpp-tls`.

.. _cpp-mongo-aws:

Expand Down
2 changes: 1 addition & 1 deletion source/security/enterprise-authentication.txt
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ authentication mechanism often used with TLS or another encryption layer.
PLAIN SASL is a clear-text authentication mechanism. We strongly recommend that you
use TLS/SSL with certificate validation when using PLAIN SASL to authenticate to MongoDB.

.. TODO: To learn more about how to enable TLS for your connection, see :ref:`<cpp-tls>`.
To learn more about how to enable TLS for your connection, see :ref:`<cpp-tls>`.

To authenticate with SASL, set the ``authMechanism`` connection option to ``PLAIN``.
You can set this option through a parameter in your connection string, as shown
Expand Down
5 changes: 2 additions & 3 deletions source/write/insert.txt
Original file line number Diff line number Diff line change
Expand Up @@ -157,9 +157,8 @@ insert operation bypasses document-level validation:
Additional Information
----------------------

.. TODO:
For runnable code examples of inserting documents with the {+driver-short+}, see
:ref:`cpp-write`.
For runnable code examples of inserting documents with the {+driver-short+}, see
:ref:`cpp-write`.

For more examples that use the ``insert_one()`` and ``insert_many()`` methods, see the
:ref:`cpp-tutorial-insert` section of the Tutorial page.
Expand Down

0 comments on commit 0b6d8c9

Please sign in to comment.