Convert the Deprecated section to an admonition
Marco Ricci

Marco Ricci commited on 2025-01-19 21:46:23
Zeige 1 geänderte Dateien mit 5 Einfügungen und 4 Löschungen.


The Deprecated section has always been non-standard, and
`mkdocstrings-python` recently removed explicit support for this.  The
recommended alternative is an explicit admonition in section notation
(i.e., a section named Warning, or Danger, or whatever), which is still
very readable in the docstring and conveys a clear intention.

References:
[mkdocstrings/python#227](https://github.com/mkdocstrings/python/issues/227).
... ...
@@ -264,10 +264,11 @@ def validate_vault_config(  # noqa: C901,PLR0912
264 264
             An entry in the vault config is not allowed, or has a
265 265
             disallowed value.
266 266
 
267
-    Deprecated:
268
-        Since v0.4.0: The `allow_derivepassphrase_extensions` keyword
269
-        argument is deprecated, and will be removed in v1.0.  There are
270
-        no specified `derivepassphrase` extensions.
267
+    Warning: Deprecated argument
268
+        **v0.4.0**:
269
+            The `allow_derivepassphrase_extensions` keyword argument is
270
+            deprecated, and will be removed in v1.0.  There are no
271
+            specified `derivepassphrase` extensions.
271 272
 
272 273
     """
273 274
     err_obj_not_a_dict = 'vault config is not a dict'
274 275