summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/api.rst15
1 files changed, 13 insertions, 2 deletions
diff --git a/docs/api.rst b/docs/api.rst
index 253ddd5..c87674a 100644
--- a/docs/api.rst
+++ b/docs/api.rst
@@ -1,8 +1,8 @@
PyISDA
======
-:mod:`~pyisda.cdsone` contains the two work horse functions of the library,
-which allow to convert back and forth from upfront to spread
+:mod:`~pyisda.cdsone` contains the two workhorse functions of the library,
+which allow to convert back and forth from upfront to spread.
.. autosummary::
pyisda.cdsone.upfront_charge
@@ -21,3 +21,14 @@ which allow to convert back and forth from upfront to spread
.. automodule:: pyisda.curve
:members:
:undoc-members:
+
+:mod:`~pyisda.legs` contains two types of Legs:
+
+.. autosummary::
+ pyisda.legs.FeeLeg
+ pyisda.legs.ContingentLeg
+
+
+.. automodule:: pyisda.legs
+ :members:
+ :undoc-members: