Skip to content

Commit

Permalink
docs: fix sphinx formatting and syntax (#235)
Browse files Browse the repository at this point in the history
  • Loading branch information
mattsb42-aws committed Apr 1, 2020
1 parent 1d9189d commit cbce224
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 3 deletions.
2 changes: 1 addition & 1 deletion src/aws_encryption_sdk/keyrings/aws_kms/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ class KmsKeyring(Keyring):
If you specify ``is_discovery=True`` the keyring will be a KMS discovery keyring,
doing nothing on encrypt and attempting to decrypt any AWS KMS-encrypted data key on decrypt.
.. notice::
.. note::
You must either set ``is_discovery=True`` or provide key IDs.
Expand Down
3 changes: 2 additions & 1 deletion src/aws_encryption_sdk/keyrings/raw.py
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,8 @@ class RawAESKeyring(Keyring):
:param WrappingAlgorithm wrapping_algorithm: Wrapping Algorithm with which to wrap plaintext data key.
.. note::
Only one wrapping key can be specified in a Raw AES Keyring
Only one wrapping key can be specified in a Raw AES Keyring
"""

key_namespace = attr.ib(validator=instance_of(six.string_types))
Expand Down
2 changes: 1 addition & 1 deletion src/aws_encryption_sdk/structures.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
class MasterKeyInfo(object):
"""Contains information necessary to identify a Master Key.
.. notice::
.. note::
The only keyring or master key that should need to set ``key_name`` is the Raw AES keyring/master key.
For all other keyrings and master keys, ``key_info`` and ``key_name`` should always be the same.
Expand Down

0 comments on commit cbce224

Please sign in to comment.