commit: bec83bf98b3d9618fb8e78f185d4838bdb14889b
Author: Brian Harring <ferringb <AT> gmail <DOT> com>
AuthorDate: Sun Dec 7 21:10:30 2025 +0000
Commit: Brian Harring <ferringb <AT> gmail <DOT> com>
CommitDate: Sun Dec 7 21:10:30 2025 +0000
URL:
https://gitweb.gentoo.org/proj/pkgcore/snakeoil.git/commit/?id=bec83bf9
doc: tweak deprecation module doc to be a bit clearer. Still feels opaque
Signed-off-by: Brian Harring <ferringb <AT> gmail.com>
src/snakeoil/deprecation.py | 5 +++++
1 file changed, 5 insertions(+)
diff --git a/src/snakeoil/deprecation.py b/src/snakeoil/deprecation.py
index 9139df5..26769c0 100644
--- a/src/snakeoil/deprecation.py
+++ b/src/snakeoil/deprecation.py
@@ -7,6 +7,11 @@ to be attached to the deprecation, and tracking all
deprecations created
by that registry. This allows tests to do introspection for deprecations
that can now be removed.
+To use this, instantiate a registry, and then use it to decorate functions
+(exactly like warnings.deprecated in py3.13). This just keeps a record of
+them so that code analysis can be done for things that need to be removed
+when future conditions are met.
+
"""
__all__ = ("Registry", "RecordCallable", "suppress_deprecations")
