Improve docstrings for sphinx.

[python_utils.git] / type_utils.py

diff --git a/type_utils.py b/type_utils.py
index 5e4187ec03658de957983a705349dda80876cd6d..e760dba90412355579ea042bf0fa760960d644c5 100644 (file)
--- a/type_utils.py
+++ b/type_utils.py
@@ -12,9 +12,16 @@ logger = logging.getLogger(__name__)
 
 def unwrap_optional(x: Optional[Any]) -> Any:
     """Unwrap an Optional[Type] argument returning a Type value back.
-    If the Optional[Type] argument is None, however, raise an exception.
-    Use this to satisfy most type checkers that a value that could
-    be None isn't so as to drop the Optional typing hint.
+    Use this to satisfy most type checkers that a value that could be
+    None isn't so as to drop the Optional typing hint.
+
+    Args:
+        x: an Optional[Type] argument
+
+    Returns:
+        If the Optional[Type] argument is non-None, return it.
+        If the Optional[Type] argument is None, however, raise an
+        exception.
 
     >>> x: Optional[bool] = True
     >>> unwrap_optional(x)
@@ -25,7 +32,6 @@ def unwrap_optional(x: Optional[Any]) -> Any:
     Traceback (most recent call last):
     ...
     AssertionError: Argument to unwrap_optional was unexpectedly None
-
     """
     if x is None:
         msg = 'Argument to unwrap_optional was unexpectedly None'