diff options
| author | Guillaume Horel <guillaume.horel@serenitascapital.com> | 2016-10-25 11:34:16 -0400 |
|---|---|---|
| committer | Guillaume Horel <guillaume.horel@serenitascapital.com> | 2016-10-25 11:34:16 -0400 |
| commit | 3e994c495065c371c4ee136146bb5dbb6512fa63 (patch) | |
| tree | 39beb1cdebb7d25bfa117a7af8ac575fbdfc5728 /docs/api.rst | |
| parent | d1f5259a5682346e0cb7ad342fe39581999f868c (diff) | |
| download | pyisda-3e994c495065c371c4ee136146bb5dbb6512fa63.tar.gz | |
improve docs
Diffstat (limited to 'docs/api.rst')
| -rw-r--r-- | docs/api.rst | 15 |
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: |