summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGuillaume Horel <guillaume.horel@gmail.com>2017-02-15 14:42:05 -0500
committerGuillaume Horel <guillaume.horel@gmail.com>2017-02-15 14:42:05 -0500
commit768c6dd8e08ba0e2cb04fd5561270eac51835716 (patch)
tree70f3d638ed7cb3d05ab1209acfbc1c55ea10337b
parent333a74ad536c4804ceee9c8d2ad7b19c3f4f3b6d (diff)
downloadpyisda-768c6dd8e08ba0e2cb04fd5561270eac51835716.tar.gz
cleanup docstring
-rw-r--r--pyisda/curve.pyx5
1 files changed, 2 insertions, 3 deletions
diff --git a/pyisda/curve.pyx b/pyisda/curve.pyx
index e481c22..46dac79 100644
--- a/pyisda/curve.pyx
+++ b/pyisda/curve.pyx
@@ -378,7 +378,6 @@ cdef class SpreadCurve(Curve):
def tweak_curve(self, double epsilon, bint multiplicative=True,
bint[:] mask=None, inplace=True):
"""
-
Tweak the survival curve in place.
Parameters
@@ -386,10 +385,10 @@ cdef class SpreadCurve(Curve):
epsilon : double
tweaking factor (either additive or multiplicative)
multiplicative : bool, optional
- do we scale by 1+epsilon or add epsilon (default multiplicative)
+ do we scale by 1+epsilon or add epsilon (default multiplicative).
mask : array of bool or None
If None (default), tweak everything, otherwise only tweak values
- in the mask
+ in the mask.
"""
## We want to tweak in the forward space, so we convert the hazard rates
## into forward rates and then back