Skip to content

Commit fdf0657

Browse files
committed
docs: add keyrings link and clarify how CryptoResult could break you
1 parent 375b910 commit fdf0657

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

CHANGELOG.rst

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,17 @@ Changelog
88
Major Features
99
--------------
1010

11-
* Add Keyrings
11+
* Add `keyrings`_.
1212
* Change one-step APIs to return a :class:`CryptoResult` rather than a tuple.
13-
* Changed APIs: ``aws_encryption_sdk.encrypt`` and ``aws_encryption_sdk.decrypt``.
13+
* Modified APIs: ``aws_encryption_sdk.encrypt`` and ``aws_encryption_sdk.decrypt``.
1414

1515
.. note::
1616

1717
For backwards compatibility,
1818
:class:`CryptoResult` also unpacks like a 2-member tuple.
1919
This allows for backwards compatibility with the previous outputs
20-
so this change should not break any existing consumers.
20+
so this change should not break any existing consumers
21+
unless you are specifically relying on the output being an instance of :class:`tuple`.
2122

2223

2324
1.4.1 -- 2019-09-20
@@ -211,3 +212,4 @@ Minor
211212
.. _pylint: https://www.pylint.org/
212213
.. _flake8: http://flake8.pycqa.org/en/latest/
213214
.. _doc8: https://launchpad.net/doc8
215+
.. _keyrings: https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/choose-keyring.html

0 commit comments

Comments
 (0)