DOC: improved docstrings for fucntions with variable arguments

murrayrm · murrayrm · commit b881b77e485b · 2017-12-28T21:00:58.000-08:00
diff --git a/control/bdalg.py b/control/bdalg.py
@@ -246,7 +246,8 @@ def feedback(sys1, sys2=1, sign=-1):
     return sys1.feedback(sys2, sign)
 
 def append(*sys):
-    '''
+    '''append(sys1, sys2, ... sysn)
+
     Group models by appending their inputs and outputs
 
     Forms an augmented system model, and appends the inputs and
diff --git a/control/margins.py b/control/margins.py
@@ -336,7 +336,9 @@ def phase_crossover_frequencies(sys):
 
 
 def margin(*args):
-    """Calculate gain and phase margins and associated crossover frequencies
+    """margin(sys)
+
+    Calculate gain and phase margins and associated crossover frequencies
 
     Parameters
     ----------
diff --git a/control/matlab/wrappers.py b/control/matlab/wrappers.py
@@ -10,7 +10,9 @@
 __all__ = ['bode', 'ngrid', 'dcgain']
 
 def bode(*args, **keywords):
-    """Bode plot of the frequency response
+    """bode(syslist[, omega, dB, Hz, deg, ...])
+
+    Bode plot of the frequency response
 
     Plots a bode gain and phase diagram
 
diff --git a/control/statefbk.py b/control/statefbk.py
@@ -144,7 +144,9 @@ def acker(A, B, poles):
     return K
 
 def lqr(*args, **keywords):
-    """Linear quadratic regulator design
+    """lqr(A, B, Q, R[, N])
+
+    Linear quadratic regulator design
 
     The lqr() function computes the optimal state feedback controller
     that minimizes the quadratic cost
diff --git a/control/statesp.py b/control/statesp.py
@@ -1052,7 +1052,8 @@ def ss(*args):
         raise ValueError("Needs 1 or 4 arguments; received %i." % len(args))
 
 def tf2ss(*args):
-    """
+    """tf2ss(sys)
+
     Transform a transfer function to a state space system.
 
     The function accepts either 1 or 2 parameters:
diff --git a/control/xferfcn.py b/control/xferfcn.py
@@ -1273,7 +1273,8 @@ def tf(*args):
         raise ValueError("Needs 1 or 2 arguments; received %i." % len(args))
 
 def ss2tf(*args):
-    """
+    """ss2tf(sys)
+
     Transform a state space system to a transfer function.
 
     The function accepts either 1 or 4 parameters:
