@@ -90,7 +90,7 @@ def __exit__(self, *args):
9090no_warnings = NoWarnings () # This is the object that should be used, not the class above
9191
9292def max_or_zero (* args , ** kwargs ):
93- """returns max(*args) or zero if given an empty sequence (in which case max() would throw an error)"""
93+ """returns max(\ *args) or zero if given an empty sequence (in which case max() would throw an error)"""
9494 if not args :
9595 return 0
9696 if not args [0 ]:
@@ -1451,18 +1451,22 @@ def sine4_reverse_ramp(self, t, duration, initial, final, samplerate, units=None
14511451 def exp_ramp (self , t , duration , initial , final , samplerate , zero = 0 , units = None , truncation = None , truncation_type = 'linear' , ** kwargs ):
14521452 """Exponential ramp whose rate of change is set by an asymptotic value (zero argument).
14531453
1454- Parameters:
1455- t, duration : time to start the ramp and its duration
1456- initial, final : initial and final values of the ramp (sans truncation)
1457- zero: asymptotic value of the exponential decay/rise, i.e. limit as t --> inf
1458- samplerate: rate to sample the function
1459- units: unit conversion to apply to specified values before generating raw output
1460- truncation_type: 'linear' or 'exponential'
1461- 'linear' truncation stops the ramp when it reaches the value given by the
1462- truncation parameter, which must be between initial and final
1463- 'exponential' truncation stops the ramp after a period of truncation*duration
1464- In this instance, the truncation parameter should be between 0 (full truncation)
1465- and 1 (no truncation).
1454+ Args:
1455+ t (float): time to start the ramp
1456+ duration (float): duration of the ramp
1457+ initial (float): initial value of the ramp (sans truncation)
1458+ final (float): final value of the ramp (sans truncation)
1459+ zero (float): asymptotic value of the exponential decay/rise, i.e. limit as t --> inf
1460+ samplerate (float): rate to sample the function
1461+ units: unit conversion to apply to specified values before generating raw output
1462+ truncation_type (str):
1463+
1464+ * `'linear'` truncation stops the ramp when it reaches the value given by the
1465+ truncation parameter, which must be between initial and final
1466+ * `'exponential'` truncation stops the ramp after a period of truncation*duration
1467+ In this instance, the truncation parameter should be between 0 (full truncation)
1468+ and 1 (no truncation).
1469+
14661470 """
14671471 # Backwards compatibility for old kwarg names
14681472 if 'trunc' in kwargs :
@@ -1493,19 +1497,23 @@ def exp_ramp(self, t, duration, initial, final, samplerate, zero=0, units=None,
14931497
14941498 def exp_ramp_t (self , t , duration , initial , final , time_constant , samplerate , units = None , truncation = None , truncation_type = 'linear' , ** kwargs ):
14951499 """Exponential ramp whose rate of change is set by the time_constant.
1496-
1497- Parameters:
1498- t, duration : time to start the ramp and its duration
1499- initial, final : initial and final values of the ramp (sans truncation)
1500- time_constant: 1/e time of the exponential decay/rise
1501- samplerate: rate to sample the function
1502- units: unit conversion to apply to specified values before generating raw output
1503- truncation_type: 'linear' or 'exponential'
1504- 'linear' truncation stops the ramp when it reaches the value given by the
1505- truncation parameter, which must be between initial and final
1506- 'exponential' truncation stops the ramp after a period of truncation*duration
1507- In this instance, the truncation parameter should be between 0 (full truncation)
1508- and 1 (no truncation).
1500+
1501+ Args:
1502+ t (float): time to start the ramp
1503+ duration (float): duration of the ramp
1504+ initial (float): initial value of the ramp (sans truncation)
1505+ final (float): final value of the ramp (sans truncation)
1506+ time_constant (float): 1/e time of the exponential decay/rise
1507+ samplerate (float): rate to sample the function
1508+ units: unit conversion to apply to specified values before generating raw output
1509+ truncation_type (str):
1510+
1511+ * `'linear'` truncation stops the ramp when it reaches the value given by the
1512+ truncation parameter, which must be between initial and final
1513+ * `'exponential'` truncation stops the ramp after a period of truncation*duration
1514+ In this instance, the truncation parameter should be between 0 (full truncation)
1515+ and 1 (no truncation).
1516+
15091517 """
15101518 # Backwards compatibility for old kwarg names
15111519 if 'trunc' in kwargs :
0 commit comments