Skip to content

Commit aba6bce

Browse files
committed
fix: README.rst must pass doc8
1 parent 2164bd7 commit aba6bce

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -310,7 +310,7 @@ to your use-case in order to obtain peak performance.
310310
Thread safety
311311
==========================
312312
The ``EncryptionSDKClient`` and all provided ``CryptoMaterialsManager`` are thread safe.
313-
But instances of ``BaseKMSMasterKeyProvider`` MUST not be shared between threads,
313+
But instances of ``BaseKMSMasterKeyProvider`` MUST not be shared between threads,
314314
for the reasons outlined in `the boto3 docs <https://boto3.amazonaws.com/v1/documentation/api/latest/guide/resources.html#multithreading-or-multiprocessing-with-resources>`_.
315315

316316
Because the ``BaseKMSMaterKeyProvider`` creates a `new boto3 sessions <https://github.com/aws/aws-encryption-sdk-python/blob/08f305a9b7b5fc897d9cafac55fb98f3f2a6fe13/src/aws_encryption_sdk/key_providers/kms.py#L665-L674>`_ per region,
@@ -319,7 +319,7 @@ a new ``BaseKMSMasterKeyProvider`` per thread is sufficient.
319319

320320
(The ``BaseKMSMasterKeyProvider`` is the internal parent class of all the KMS Providers.)
321321

322-
Finally, while the ``CryptoMaterialsCache`` is thread safe,
322+
Finally, while the ``CryptoMaterialsCache`` is thread safe,
323323
sharing entries in that cache across threads needs to be done carefully
324324
(see the !Note about partition name `in the API Docs <https://aws-encryption-sdk-python.readthedocs.io/en/latest/generated/aws_encryption_sdk.materials_managers.caching.html#aws_encryption_sdk.materials_managers.caching.CachingCryptoMaterialsManager>`_).
325325

0 commit comments

Comments
 (0)