From 3e994c495065c371c4ee136146bb5dbb6512fa63 Mon Sep 17 00:00:00 2001 From: Guillaume Horel Date: Tue, 25 Oct 2016 11:34:16 -0400 Subject: improve docs --- docs/api.rst | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) (limited to 'docs') 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: -- cgit v1.2.3-70-g09d2