Improve docs for internal _F class

lsst · Oct 7, 2021 · d266763 · d266763
1 parent 6d6b01a
commit d266763
Showing 1 changed file with 6 additions and 2 deletions.
diff --git a/python/lsst/utils/logging.py b/python/lsst/utils/logging.py
@@ -37,8 +37,12 @@
 
 class _F:
     """
-    Format, supporting str.format() syntax
-    see using-custom-message-objects in logging-cookbook.html
+    Format, supporting `str.format()` syntax.
+
+    Notes
+    -----
+    This follows the recommendation from
+    https://docs.python.org/3/howto/logging-cookbook.html#using-custom-message-objects
     """
     def __init__(self, fmt: str, /, *args: Any, **kwargs: Any):
         self.fmt = fmt