aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorPaul Kehrer <paul.l.kehrer@gmail.com>2023-12-23 16:48:55 -0300
committerGitHub <noreply@github.com>2023-12-23 14:48:55 -0500
commit8046ea1c498177c49322304fe0c77483ab19c161 (patch)
treee7c06f8be5e78883b75bb77e721de1df560ac346 /docs
parent20aacdd6960312d901e0fb351b4ef28838a3ec13 (diff)
downloadpyca-cryptography-8046ea1c498177c49322304fe0c77483ab19c161.zip
pyca-cryptography-8046ea1c498177c49322304fe0c77483ab19c161.tar.gz
pyca-cryptography-8046ea1c498177c49322304fe0c77483ab19c161.tar.bz2
document that we raise CryptographyDeprecationWarning on deprecation more clearly (#10053)
* document we raise CryptographyDeprecationWarning clearly * be a little louder about our deprecated ciphers
Diffstat (limited to 'docs')
-rw-r--r--docs/api-stability.rst4
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/api-stability.rst b/docs/api-stability.rst
index eafbd1d..0ed03dc 100644
--- a/docs/api-stability.rst
+++ b/docs/api-stability.rst
@@ -66,9 +66,9 @@ entirely. In that case, here's how the process will work:
* In ``cryptography X.0.0`` the feature exists.
* In ``cryptography (X + 1).0.0`` using that feature will emit a
- ``UserWarning``.
+ ``CryptographyDeprecationWarning`` (base class ``UserWarning``).
* In ``cryptography (X + 2).0.0`` using that feature will emit a
- ``UserWarning``.
+ ``CryptographyDeprecationWarning``.
* In ``cryptography (X + 3).0.0`` the feature will be removed or changed.
In short, code that runs without warnings will always continue to work for a