DEP: deprecate IndexCurve in favour of enhanced Curve (#560)

Co-authored-by: JHM Darbyshire (M1) <[email protected]>
attack68 · Dec 19, 2024 · b5c5744 · b5c5744
1 parent 4f6410e
commit b5c5744
Show file tree

Hide file tree

Showing 3 changed files with 256 additions and 222 deletions.
diff --git a/docs/source/i_whatsnew.rst b/docs/source/i_whatsnew.rst
@@ -21,6 +21,10 @@ email contact, see `rateslib <https://rateslib.com>`_.
 
    * - Feature
      - Description
+   * - **Deprecation**
+     - :class:`~rateslib.curves.IndexCurve` is deprecated. Use :class:`~rateslib.curves.Curve`
+       instead.
+       (`560 <https://github.com/attack68/rateslib/pull/560>`_)
    * - Instruments
      - :meth:`~rateslib.instruments.FloatRateNote.ytm` added to
        :class:`~rateslib.instruments.FloatRateNote` to allow the calculation of
@@ -48,6 +52,9 @@ email contact, see `rateslib <https://rateslib.com>`_.
        (`536 <https://github.com/attack68/rateslib/pull/536>`_)
    * - Dependencies
      - Drop support for Python 3.9, only versions 3.10 - 3.13 now supported.
+   * - Refactor
+       :class:`~rateslib.curves.CompositeCurve` no longer requires all curves to have the same ``index_base``
+       or ``index_lag``. Those values will be sampled from the first provided composited *Curve*.
    * - Refactor
      - :red:`Minor Breaking Change!` :meth:`~rateslib.calendars.get_calendar` has dropped the
        ``kind`` argument being only useful internally.