mongodb/mongo-python-driver
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

PYTHON-4536 Cleanup param doc strings (#1725)

Browse Source
This commit is contained in:
Shane Harvey 2024-07-05 17:09:20 -04:00 committed by GitHub
parent f5b102ab2a
commit e4ba8ce6a3
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 14 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
pymongo/asynchronous/database.py
View File

@ -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`.

10
pymongo/asynchronous/encryption.py
View File

@ -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`.

4
pymongo/synchronous/database.py
View File

@ -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`.

10
pymongo/synchronous/encryption.py
View File

@ -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`.