DOC: edit NonDeliverableCashflow (#650)

Co-authored-by: JHM Darbyshire (M1) <[email protected]>
attack68 · Jan 25, 2025 · ccfb5f7 · ccfb5f7
1 parent 2ccb97b
commit ccfb5f7
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 1 deletion.
diff --git a/docs/source/d_periods.rst b/docs/source/d_periods.rst
@@ -38,6 +38,7 @@ of each *Period* type:
    rateslib.periods.Cashflow
    rateslib.periods.IndexFixedPeriod
    rateslib.periods.IndexCashflow
+   rateslib.periods.NonDeliverableCashflow
 
 **Common methods**
 

diff --git a/python/rateslib/periods/cashflow.py b/python/rateslib/periods/cashflow.py
@@ -312,7 +312,19 @@ def npv(
         return _maybe_local(disc_cashflow, local, self.settlement_currency, fx, base)
 
     def cashflow(self, fx: FX_) -> DualTypes:
-        """Cashflow is expressed in the settlement, i.e. deliverable currency."""
+        """
+        Determine the cashflow amount, expressed in ``settlement_currency``.
+
+        Parameters
+        ----------
+        fx: FXforwards, optional
+            Required to forecast the FX rate at settlement, if an ``fx_fixing`` is not known.
+
+        Returns
+        -------
+        float, Dual, Dual2
+        """
+
         if isinstance(self.fx_fixing, NoInput):
             fx_ = _validate_fx_as_forwards(fx)
             fx_fixing: DualTypes = fx_.rate(self.pair, self.settlement)