From 0b6d8c90d3e6ae37f01ca02159178cea7fb0acd2 Mon Sep 17 00:00:00 2001 From: norareidy Date: Fri, 2 Aug 2024 17:13:18 -0400 Subject: [PATCH] resolve TODOs --- source/get-started/create-a-connection-string.txt | 3 ++- source/polyfill-selection.txt | 5 +---- source/read/retrieve.txt | 15 ++++++++------- source/security/authentication.txt | 2 +- source/security/enterprise-authentication.txt | 2 +- source/write/insert.txt | 5 ++--- 6 files changed, 15 insertions(+), 17 deletions(-) diff --git a/source/get-started/create-a-connection-string.txt b/source/get-started/create-a-connection-string.txt index 26aba9d8..a5a84504 100644 --- a/source/get-started/create-a-connection-string.txt +++ b/source/get-started/create-a-connection-string.txt @@ -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 diff --git a/source/polyfill-selection.txt b/source/polyfill-selection.txt index 358e0969..26e9974e 100644 --- a/source/polyfill-selection.txt +++ b/source/polyfill-selection.txt @@ -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`` with non-mongocxx library interfaces. - -.. button:: Next: Download and Install - :uri: /get-started/download-and-install/ \ No newline at end of file + 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`` with non-mongocxx library interfaces. \ No newline at end of file diff --git a/source/read/retrieve.txt b/source/read/retrieve.txt index e9707e70..3c85ca70 100644 --- a/source/read/retrieve.txt +++ b/source/read/retrieve.txt @@ -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: @@ -100,8 +101,8 @@ the ``name`` field has the value ``"LinkedIn"``: :manual:`natural order ` on disk if no sort criteria is specified. -.. TODO: - To learn more about sorting, see the :ref:`sort guide `. +To learn more about sorting, see the :ref:`cpp-return-documents-sort` +section of the Specify Documents to Return guide. .. _cpp-retrieve-find-multiple: @@ -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. diff --git a/source/security/authentication.txt b/source/security/authentication.txt index 83ff27f4..a52622fa 100644 --- a/source/security/authentication.txt +++ b/source/security/authentication.txt @@ -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: diff --git a/source/security/enterprise-authentication.txt b/source/security/enterprise-authentication.txt index fb660935..dd95017d 100644 --- a/source/security/enterprise-authentication.txt +++ b/source/security/enterprise-authentication.txt @@ -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:``. +To learn more about how to enable TLS for your connection, see :ref:``. 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 diff --git a/source/write/insert.txt b/source/write/insert.txt index b258083f..3f6a19a6 100644 --- a/source/write/insert.txt +++ b/source/write/insert.txt @@ -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.