diff --git a/pymongo/asynchronous/database.py b/pymongo/asynchronous/database.py index f7a07027c..21a95667e 100644 --- a/pymongo/asynchronous/database.py +++ b/pymongo/asynchronous/database.py @@ -489,7 +489,7 @@ class AsyncDatabase(common.BaseObject, Generic[_DocumentType]): :class:`~pymongo.collation.Collation`. :param session: a :class:`~pymongo.client_session.AsyncClientSession`. - :param `check_exists`: if True (the default), send a listCollections command to + :param check_exists: if True (the default), send a listCollections command to check if the collection already exists before creation. :param kwargs: additional keyword arguments will be passed as options for the `create collection command`_ @@ -949,7 +949,7 @@ class AsyncDatabase(common.BaseObject, Generic[_DocumentType]): read preference configured for the transaction. Otherwise, defaults to :attr:`~pymongo.read_preferences.ReadPreference.PRIMARY`. - :param codec_options`: A :class:`~bson.codec_options.CodecOptions` + :param codec_options: A :class:`~bson.codec_options.CodecOptions` instance. :param session: A :class:`~pymongo.client_session.AsyncClientSession`. diff --git a/pymongo/asynchronous/encryption.py b/pymongo/asynchronous/encryption.py index 13f11c326..19db50de8 100644 --- a/pymongo/asynchronous/encryption.py +++ b/pymongo/asynchronous/encryption.py @@ -1005,10 +1005,10 @@ class ClientEncryption(Generic[_DocumentType]): async def add_key_alt_name(self, id: Binary, key_alt_name: str) -> Any: """Add ``key_alt_name`` to the set of alternate names in the key document with UUID ``key_id``. - :param `id`: The UUID of a key a which must be a + :param id: The UUID of a key a which must be a :class:`~bson.binary.Binary` with subtype 4 ( :attr:`~bson.binary.UUID_SUBTYPE`). - :param `key_alt_name`: The key alternate name to add. + :param key_alt_name: The key alternate name to add. :return: The previous version of the key document. @@ -1037,10 +1037,10 @@ class ClientEncryption(Generic[_DocumentType]): Also removes the ``keyAltNames`` field from the key document if it would otherwise be empty. - :param `id`: The UUID of a key a which must be a + :param id: The UUID of a key a which must be a :class:`~bson.binary.Binary` with subtype 4 ( :attr:`~bson.binary.UUID_SUBTYPE`). - :param `key_alt_name`: The key alternate name to remove. + :param key_alt_name: The key alternate name to remove. :return: Returns the previous version of the key document. @@ -1079,7 +1079,7 @@ class ClientEncryption(Generic[_DocumentType]): :param filter: A document used to filter the data keys. :param provider: The new KMS provider to use to encrypt the data keys, or ``None`` to use the current KMS provider(s). - :param `master_key`: The master key fields corresponding to the new KMS + :param master_key: The master key fields corresponding to the new KMS provider when ``provider`` is not ``None``. :return: A :class:`RewrapManyDataKeyResult`. diff --git a/pymongo/synchronous/database.py b/pymongo/synchronous/database.py index eaef0558d..08e0a3e6d 100644 --- a/pymongo/synchronous/database.py +++ b/pymongo/synchronous/database.py @@ -489,7 +489,7 @@ class Database(common.BaseObject, Generic[_DocumentType]): :class:`~pymongo.collation.Collation`. :param session: a :class:`~pymongo.client_session.ClientSession`. - :param `check_exists`: if True (the default), send a listCollections command to + :param check_exists: if True (the default), send a listCollections command to check if the collection already exists before creation. :param kwargs: additional keyword arguments will be passed as options for the `create collection command`_ @@ -947,7 +947,7 @@ class Database(common.BaseObject, Generic[_DocumentType]): read preference configured for the transaction. Otherwise, defaults to :attr:`~pymongo.read_preferences.ReadPreference.PRIMARY`. - :param codec_options`: A :class:`~bson.codec_options.CodecOptions` + :param codec_options: A :class:`~bson.codec_options.CodecOptions` instance. :param session: A :class:`~pymongo.client_session.ClientSession`. diff --git a/pymongo/synchronous/encryption.py b/pymongo/synchronous/encryption.py index 909fd12c8..e06ddad93 100644 --- a/pymongo/synchronous/encryption.py +++ b/pymongo/synchronous/encryption.py @@ -1003,10 +1003,10 @@ class ClientEncryption(Generic[_DocumentType]): def add_key_alt_name(self, id: Binary, key_alt_name: str) -> Any: """Add ``key_alt_name`` to the set of alternate names in the key document with UUID ``key_id``. - :param `id`: The UUID of a key a which must be a + :param id: The UUID of a key a which must be a :class:`~bson.binary.Binary` with subtype 4 ( :attr:`~bson.binary.UUID_SUBTYPE`). - :param `key_alt_name`: The key alternate name to add. + :param key_alt_name: The key alternate name to add. :return: The previous version of the key document. @@ -1035,10 +1035,10 @@ class ClientEncryption(Generic[_DocumentType]): Also removes the ``keyAltNames`` field from the key document if it would otherwise be empty. - :param `id`: The UUID of a key a which must be a + :param id: The UUID of a key a which must be a :class:`~bson.binary.Binary` with subtype 4 ( :attr:`~bson.binary.UUID_SUBTYPE`). - :param `key_alt_name`: The key alternate name to remove. + :param key_alt_name: The key alternate name to remove. :return: Returns the previous version of the key document. @@ -1077,7 +1077,7 @@ class ClientEncryption(Generic[_DocumentType]): :param filter: A document used to filter the data keys. :param provider: The new KMS provider to use to encrypt the data keys, or ``None`` to use the current KMS provider(s). - :param `master_key`: The master key fields corresponding to the new KMS + :param master_key: The master key fields corresponding to the new KMS provider when ``provider`` is not ``None``. :return: A :class:`RewrapManyDataKeyResult`.