summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGuillaume Horel <guillaume.horel@gmail.com>2019-02-05 15:17:19 -0500
committerGuillaume Horel <guillaume.horel@gmail.com>2019-02-05 15:17:19 -0500
commit3167341d4e9e28075b561666f9bd724d91dff062 (patch)
tree06f89d64d604bd688dd1cca89f9bfda8b24f4f98
parent937e0728dba3b2eb2879723a4fdd6791809459ff (diff)
downloadpyisda-3167341d4e9e28075b561666f9bd724d91dff062.tar.gz
add docstring
-rw-r--r--pyisda/curve.pyx8
1 files changed, 7 insertions, 1 deletions
diff --git a/pyisda/curve.pyx b/pyisda/curve.pyx
index 6af2176..7c9a8f3 100644
--- a/pyisda/curve.pyx
+++ b/pyisda/curve.pyx
@@ -798,7 +798,13 @@ cdef class SpreadCurve(Curve):
@cython.boundscheck(False)
def par_spread(self, today, step_in_date, start_date, end_dates,
- double[:] recovery_rates, YieldCurve yc, bint pay_accrued_on_default):
+ double[:] recovery_rates, YieldCurve yc not None,
+ bint pay_accrued_on_default=True):
+ """
+ Parameters
+ ----------
+ recovery_rates : should be same length as end_dates
+ """
cdef TDate today_c = pydate_to_TDate(today)
cdef TDate step_in_date_c = pydate_to_TDate(step_in_date)
cdef TDate start_date_c = pydate_to_TDate(start_date)