fix up docstrings for append() methods after rebase

murrayrm · murrayrm · commit d601d38eddbc · 2025-01-20T10:54:48.000-08:00
diff --git a/control/frdata.py b/control/frdata.py
@@ -848,7 +848,19 @@ def append(self, other):
         """Append a second model to the present model.
 
         The second model is converted to FRD if necessary, inputs and
-        outputs are appended and their order is preserved"""
+        outputs are appended and their order is preserved.
+
+        Parameters
+        ----------
+        other : `LTI`
+            System to be appended.
+
+        Returns
+        -------
+        sys : `FrequencyResponseData`
+            System model with `other` appended to `self`.
+
+        """
         other = _convert_to_frd(other, omega=self.omega, inputs=other.ninputs,
                                 outputs=other.noutputs)
 
diff --git a/control/statesp.py b/control/statesp.py
@@ -1280,11 +1280,11 @@ def append(self, other):
         """Append a second model to the present model.
 
         The second model is converted to state-space if necessary, inputs and
-        outputs are appended and their order is preserved
+        outputs are appended and their order is preserved.
 
         Parameters
         ----------
-        other : `StateSpace`
+        other : `StateSpace` or `TransferFunction`
             System to be appended.
 
         Returns
diff --git a/control/xferfcn.py b/control/xferfcn.py
@@ -899,7 +899,19 @@ def append(self, other):
         """Append a second model to the present model.
 
         The second model is converted to a transfer function if necessary,
-        inputs and outputs are appended and their order is preserved"""
+        inputs and outputs are appended and their order is preserved.
+
+        Parameters
+        ----------
+        other : `StateSpace` or `TransferFunction`
+            System to be appended.
+
+        Returns
+        -------
+        sys : `TransferFunction`
+            System model with `other` appended to `self`.
+
+        """
         other = _convert_to_transfer_function(other)
 
         new_tf = bdalg.combine_tf([
