diff --git a/chainladder/core/display.py b/chainladder/core/display.py index db2ee07b..0a80c07d 100644 --- a/chainladder/core/display.py +++ b/chainladder/core/display.py @@ -158,6 +158,11 @@ def heatmap( Color the background in a gradient according to the data in each column (optionally row). Requires matplotlib. + Styles a single 2-D triangle for notebook display and returns an + IPython HTML object. Multi-dimensional triangles raise + ``ValueError``. See the :ref:`User Guide ` for a + rendered example. + Parameters ---------- @@ -173,7 +178,6 @@ def heatmap( Returns ------- Ipython.display.HTML - """ if self._dimensionality == 'single': data = self._repr_format() diff --git a/docs/user_guide/triangle.ipynb b/docs/user_guide/triangle.ipynb index 0db555b7..8f39da4b 100644 --- a/docs/user_guide/triangle.ipynb +++ b/docs/user_guide/triangle.ipynb @@ -1246,6 +1246,7 @@ "id": "a6a578af", "metadata": {}, "source": [ + "(triangle:heatmap)=\n", "### Link Ratios\n", "\n", "The age-to-age factors or link ratios of a Triangle can be accessed with the\n",