refactor: Don't emit deprecation warnings through own usage of deprec…

…ated API Issue-mkdocstrings#676: mkdocstrings/mkdocstrings#676
mkdocstrings · Aug 9, 2024 · 9922d74 · 9922d74
1 parent 03bdec6
commit 9922d74
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/src/_griffe/docstrings/utils.py b/src/_griffe/docstrings/utils.py
@@ -80,7 +80,8 @@ def docstring_warning(  # type: ignore[misc]
     """
     # YORE: Bump 1: Remove block.
     if name is not None:
-        warnings.warn("The `name` parameter is deprecated.", DeprecationWarning, stacklevel=1)
+        if not name.startswith("griffe."):
+            warnings.warn("The `name` parameter is deprecated.", DeprecationWarning, stacklevel=1)
         logger = get_logger(name)
     else:
         if docstring is _sentinel or offset is _sentinel or message is _sentinel:

diff --git a/src/_griffe/logger.py b/src/_griffe/logger.py
@@ -104,7 +104,6 @@ def _patch_logger(cls, get_logger_func: Callable) -> None:
 
 # YORE: Bump 1: Remove block.
 def get_logger(name: str) -> Logger:
-    # YORE: Bump 1: Replace `Deprecated.` with `Deprecated, use [logger][griffe.logger] directly.`.
     """Deprecated. Create and return a new logger instance.
 
     Parameters:
@@ -113,8 +112,8 @@ def get_logger(name: str) -> Logger:
     Returns:
         The logger.
     """
-    # YORE: Bump 1: Replace `deprecated.` with `deprecated. Use [logger][griffe.logger] directly.`.
-    warnings.warn("The `get_logger` function is deprecated.", DeprecationWarning, stacklevel=1)
+    if not name.startswith("griffe."):
+        warnings.warn("The `get_logger` function is deprecated.", DeprecationWarning, stacklevel=1)
     return Logger._get(name)