add check for empty section + fix correlation() docstring

murrayrm · murrayrm · commit aad3c75c3072 · 2025-02-02T20:28:24.000-08:00
diff --git a/control/stochsys.py b/control/stochsys.py
@@ -683,6 +683,10 @@ def correlation(T, X, Y=None, squeeze=True):
 
     Returns
     -------
+    tau : array
+        Array of time offsets.
+    Rtau : array
+        Correlation for each offset tau.
 
     """
     T = np.atleast_1d(T)
diff --git a/control/tests/docstrings_test.py b/control/tests/docstrings_test.py
@@ -615,10 +615,14 @@ def _check_numpydoc_style(obj, doc):
         pass
     elif inspect.isfunction(obj):
         # Specialized checks for functions
-        def _check_param(param, empty_ok=False, noname_ok=False):
+        def _check_param(param, empty_ok=False, noname_ok=False, section="??"):
             param_desc = "\n".join(param.desc)
             param_name = f"{name} '{param.name}'"
 
+            # Check for empty section
+            if param.name == "" and param.type == '':
+                _fail(f"Empty {section} section in {name}")
+
             # Make sure we have a name and description
             if param.name == "" and not noname_ok:
                 _fail(f"{param_name} has improperly formatted parameter")
@@ -636,11 +640,13 @@ def _check_param(param, empty_ok=False, noname_ok=False):
                 _warn(f"{param_name} description starts with lower case letter")
 
         for param in doc["Parameters"] + doc["Other Parameters"]:
-            _check_param(param)
+            _check_param(param, section="Parameters")
         for param in doc["Returns"]:
-            _check_param(param, empty_ok=True, noname_ok=True)
+            _check_param(
+                param, empty_ok=True, noname_ok=True, section="Returns")
         for param in doc["Yields"]:
-            _check_param(param, empty_ok=True, noname_ok=True)
+            _check_param(
+                param, empty_ok=True, noname_ok=True, section="Yields")
     else:
         raise TypeError("unknown object type for {obj}")
 
