aboutsummaryrefslogtreecommitdiff
path: root/python/python3-deprecation/README
diff options
context:
space:
mode:
Diffstat (limited to 'python/python3-deprecation/README')
-rw-r--r--python/python3-deprecation/README5
1 files changed, 5 insertions, 0 deletions
diff --git a/python/python3-deprecation/README b/python/python3-deprecation/README
new file mode 100644
index 0000000000000..2de1563977b4a
--- /dev/null
+++ b/python/python3-deprecation/README
@@ -0,0 +1,5 @@
+deprecation is a library that enables automated deprecations. It
+offers the deprecated() decorator to wrap functions, providing proper
+warnings both in documentation and via Python's warnings system,
+as well as the deprecation.fail_if_not_removed() decorator for test
+methods to ensure that deprecated code is eventually removed.