Skip to content

Commit cbce224

Browse files
authored
docs: fix sphinx formatting and syntax (#235)
1 parent 1d9189d commit cbce224

File tree

3 files changed

+4
-3
lines changed

3 files changed

+4
-3
lines changed

src/aws_encryption_sdk/keyrings/aws_kms/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ class KmsKeyring(Keyring):
6060
If you specify ``is_discovery=True`` the keyring will be a KMS discovery keyring,
6161
doing nothing on encrypt and attempting to decrypt any AWS KMS-encrypted data key on decrypt.
6262
63-
.. notice::
63+
.. note::
6464
6565
You must either set ``is_discovery=True`` or provide key IDs.
6666

src/aws_encryption_sdk/keyrings/raw.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,8 @@ class RawAESKeyring(Keyring):
7979
:param WrappingAlgorithm wrapping_algorithm: Wrapping Algorithm with which to wrap plaintext data key.
8080
8181
.. note::
82-
Only one wrapping key can be specified in a Raw AES Keyring
82+
83+
Only one wrapping key can be specified in a Raw AES Keyring
8384
"""
8485

8586
key_namespace = attr.ib(validator=instance_of(six.string_types))

src/aws_encryption_sdk/structures.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
class MasterKeyInfo(object):
3232
"""Contains information necessary to identify a Master Key.
3333
34-
.. notice::
34+
.. note::
3535
3636
The only keyring or master key that should need to set ``key_name`` is the Raw AES keyring/master key.
3737
For all other keyrings and master keys, ``key_info`` and ``key_name`` should always be the same.

0 commit comments

Comments
 (0)