rm feedback

Author: mongoKart

source/connect/mongoclient.txt

@@ -137,7 +137,12 @@ constructor accepts. All parameters are optional.
        - ``bson.raw_bson.RawBSONDocument``.
        - A subclass of the ``collections.abc.Mapping`` type, such as ``bson.son.SON``. 
          If you specify ``bson.son.SON`` as the document class, you must also specify types
-         for the key and value.
+         for the key and value, as shown in the following example:
+
+         .. code-block:: python
+
+            client = MongoClient(document_class=SON[str, int])
+       
        - A subclass of the ``TypedDict`` type. To pass a ``TypedDict`` subclass for this
          parameter, you must also include the class in a type hint for your ``MongoClient``
          object, as shown in the following example:
@@ -149,6 +154,7 @@ constructor accepts. All parameters are optional.
          .. include:: /includes/type-hints/typeddict-availability.rst
 
        **Data type:** ``Type[_DocumentType]``
+       **Default:** ``dict``
 
    * - ``tz_aware``
      - If this parameter is ``True``, the client treats ``datetime`` values as aware.

source/includes/type-hints/intro.rst

@@ -1,6 +1,6 @@
 If your application uses Python 3.5 or later, you can add *type hints*,
 as described in `PEP 484 <https://peps.python.org/pep-0484/>`__, to your code.
 Type hints denote the data types of variables, parameters, and function return
-values, as well as the structure of documents.
+values, and the structure of documents.
 Some IDEs can use type hints to check your code for type errors and suggest
 appropriate options for code completion.

source/includes/type-hints/tip-more-info.rst

@@ -0,0 +1,4 @@
+.. tip:: Type-Checking Tools
+
+   To learn more about type-checking tools available for Python, see
+   :ref:`Type Checkers <pymongo-tools-type-checkers>` on the Tools page.

source/includes/type-hints/tip-type-checkers.rst

@@ -1,8 +1,9 @@
 Incompatible Type
 ~~~~~~~~~~~~~~~~~
 
-If you use the generic form of the ``MongoClient`` class, your type checker might
-show an error similar to the following:
+If you specify ``MongoClient`` as a type hint but don't include data types for
+the document, keys, and values, your type checker might show an error similar to
+the following:
 
 .. code-block:: python
 

source/includes/type-hints/troubleshooting-incompatible-type.rst

@@ -1,3 +1,5 @@
-The ``TypedDict`` class is in the ``typing`` module, which
+The `TypedDict <https://docs.python.org/3/library/typing.html#typing.TypedDict>`__ class
+is in the ``typing`` module, which
 is available only in Python 3.8 and later. To use the ``TypedDict`` class in
-earlier versions of Python, install the ``typing_extensions`` package.
+earlier versions of Python, install the
+`typing_extensions <https://pypi.org/project/typing-extensions/>`__ package.

source/includes/type-hints/typeddict-availability.rst

@@ -199,24 +199,6 @@ to the ``find()`` method:
 
 .. include:: /includes/collation-override-note.rst
 
-Troubleshooting
----------------
-
-Modifying Raw BSON
-~~~~~~~~~~~~~~~~~~
-
-Instances of the ``RawBSONDocument`` class are read-only. If you try to set a value on a
-``RawBSONDocument`` object, you will see an error similar to one of the following:
-
-.. code-block:: python
-
-   error: Unsupported target for indexed assignment
-   ("RawBSONDocument")  [index]
-
-.. code-block:: python
-
-   TypeError: 'RawBSONDocument' object does not support item assignment
-
 .. _pymongo-retrieve-additional-information:
 
 Additional Information

source/read/retrieve.txt

@@ -193,6 +193,8 @@ class for added type safety:
 
 To replace multiple documents, you must create an instance of ``ReplaceOne`` for each document.
 
+.. include:: /includes/type-hints/tip-type-checkers.rst
+
 Delete Operations
 ~~~~~~~~~~~~~~~~~
 

source/write/bulk-write.txt

@@ -77,7 +77,9 @@ method for added type safety:
    class Restaurant(TypedDict):
        name: str
 
-   sample_restaurants.restaurants.insert_one(Movie(name="Mongo's Burgers")
+   sample_restaurants.restaurants.insert_one(Restaurant(name="Mongo's Burgers")
+
+.. include:: /includes/type-hints/tip-type-checkers.rst
 
 Insert Multiple Documents
 -------------------------
@@ -121,6 +123,8 @@ instances of the ``Restaurant`` class. This adds type safety to the insert opera
 
    sample_restaurants.restaurants.insert_many(document_list)
 
+.. include:: /includes/type-hints/tip-type-checkers.rst
+
 Modify Insert Behavior
 ----------------------
 
@@ -205,7 +209,7 @@ calling the ``insert_many()`` method instead.
 TypedDict Missing _id Key
 ~~~~~~~~~~~~~~~~~~~~~~~~~
 
-As discussed above, if you don't specify the ``_id`` field, {+driver-short+} automatically
+If you don't specify the ``_id`` field, {+driver-short+} automatically
 inserts it into the document.
 You can retrieve the value of the ``_id`` field at runtime, but if you use MyPy or another
 tool to perform static type-checking, it won't find the ``_id`` field in your class and
@@ -313,8 +317,10 @@ The following code example shows how to implement this solution:
 
 .. important:: NotRequired Requires Python 3.11+
 
-   The ``NotRequired`` class is available only in Python 3.11 and later.
-   To use ``NotRequired`` in earlier versions of Python, install the ``typing_extensions``
+   The `NotRequired <https://docs.python.org/3/library/typing.html#typing.NotRequired>`__
+   class is available only in Python 3.11 and later.
+   To use ``NotRequired`` in earlier versions of Python, install the
+   `typing_extensions <https://pypi.org/project/typing-extensions/>`__
    package instead.
 
 Additional Information