fix: border title

Author: matomatical

CHANGELOG.md

@@ -20,6 +20,10 @@ Steps to update the version:
 In development:
 ---------------
 
+Fix:
+
+* Missing title parameter from border.
+
 Version 0.3.1
 -------------
 

DOCS.md

@@ -1041,13 +1041,13 @@ Inputs:
 
 ### method border.\_\_repr\_\_
 
-**\_\_repr\_\_():** ([source](https://github.com/matomatical/matthewplotlib/blob/main/matthewplotlib/plots.py#L1267))
+**\_\_repr\_\_():** ([source](https://github.com/matomatical/matthewplotlib/blob/main/matthewplotlib/plots.py#L1269))
 
 ---
 
 ### class axes
 
-**axes(plot):** ([source](https://github.com/matomatical/matthewplotlib/blob/main/matthewplotlib/plots.py#L1271))
+**axes(plot):** ([source](https://github.com/matomatical/matthewplotlib/blob/main/matthewplotlib/plots.py#L1273))
 
 Add an annotated border around a scatterplot using box-drawing characters.
 
@@ -1081,13 +1081,13 @@ Inputs:
 
 ### method axes.\_\_repr\_\_
 
-**\_\_repr\_\_():** ([source](https://github.com/matomatical/matthewplotlib/blob/main/matthewplotlib/plots.py#L1351))
+**\_\_repr\_\_():** ([source](https://github.com/matomatical/matthewplotlib/blob/main/matthewplotlib/plots.py#L1353))
 
 ---
 
 ### class blank
 
-**blank(plot):** ([source](https://github.com/matomatical/matthewplotlib/blob/main/matthewplotlib/plots.py#L1359))
+**blank(plot):** ([source](https://github.com/matomatical/matthewplotlib/blob/main/matthewplotlib/plots.py#L1361))
 
 Creates a rectangular plot composed entirely of blank space.
 
@@ -1102,13 +1102,13 @@ Inputs:
 
 ### method blank.\_\_repr\_\_
 
-**\_\_repr\_\_():** ([source](https://github.com/matomatical/matthewplotlib/blob/main/matthewplotlib/plots.py#L1380))
+**\_\_repr\_\_():** ([source](https://github.com/matomatical/matthewplotlib/blob/main/matthewplotlib/plots.py#L1382))
 
 ---
 
 ### class hstack
 
-**hstack(plot):** ([source](https://github.com/matomatical/matthewplotlib/blob/main/matthewplotlib/plots.py#L1384))
+**hstack(plot):** ([source](https://github.com/matomatical/matthewplotlib/blob/main/matthewplotlib/plots.py#L1386))
 
 Horizontally arrange one or more plots side-by-side.
 
@@ -1122,13 +1122,13 @@ Inputs:
 
 ### method hstack.\_\_repr\_\_
 
-**\_\_repr\_\_():** ([source](https://github.com/matomatical/matthewplotlib/blob/main/matthewplotlib/plots.py#L1409))
+**\_\_repr\_\_():** ([source](https://github.com/matomatical/matthewplotlib/blob/main/matthewplotlib/plots.py#L1411))
 
 ---
 
 ### class vstack
 
-**vstack(plot):** ([source](https://github.com/matomatical/matthewplotlib/blob/main/matthewplotlib/plots.py#L1416))
+**vstack(plot):** ([source](https://github.com/matomatical/matthewplotlib/blob/main/matthewplotlib/plots.py#L1418))
 
 Vertically arrange one or more plots, one above the other.
 
@@ -1142,13 +1142,13 @@ Inputs:
 
 ### method vstack.\_\_repr\_\_
 
-**\_\_repr\_\_():** ([source](https://github.com/matomatical/matthewplotlib/blob/main/matthewplotlib/plots.py#L1441))
+**\_\_repr\_\_():** ([source](https://github.com/matomatical/matthewplotlib/blob/main/matthewplotlib/plots.py#L1443))
 
 ---
 
 ### class dstack
 
-**dstack(plot):** ([source](https://github.com/matomatical/matthewplotlib/blob/main/matthewplotlib/plots.py#L1448))
+**dstack(plot):** ([source](https://github.com/matomatical/matthewplotlib/blob/main/matthewplotlib/plots.py#L1450))
 
 Overlay one or more plots on top of each other.
 
@@ -1164,13 +1164,13 @@ Inputs:
 
 ### method dstack.\_\_repr\_\_
 
-**\_\_repr\_\_():** ([source](https://github.com/matomatical/matthewplotlib/blob/main/matthewplotlib/plots.py#L1486))
+**\_\_repr\_\_():** ([source](https://github.com/matomatical/matthewplotlib/blob/main/matthewplotlib/plots.py#L1488))
 
 ---
 
 ### class wrap
 
-**wrap(plot):** ([source](https://github.com/matomatical/matthewplotlib/blob/main/matthewplotlib/plots.py#L1493))
+**wrap(plot):** ([source](https://github.com/matomatical/matthewplotlib/blob/main/matthewplotlib/plots.py#L1495))
 
 Arrange a sequence of plots into a grid.
 
@@ -1189,13 +1189,13 @@ Inputs:
 
 ### method wrap.\_\_repr\_\_
 
-**\_\_repr\_\_():** ([source](https://github.com/matomatical/matthewplotlib/blob/main/matthewplotlib/plots.py#L1550))
+**\_\_repr\_\_():** ([source](https://github.com/matomatical/matthewplotlib/blob/main/matthewplotlib/plots.py#L1552))
 
 ---
 
 ### class center
 
-**center(plot):** ([source](https://github.com/matomatical/matthewplotlib/blob/main/matthewplotlib/plots.py#L1557))
+**center(plot):** ([source](https://github.com/matomatical/matthewplotlib/blob/main/matthewplotlib/plots.py#L1559))
 
 Pad a plot with blank space to center it within a larger area.
 
@@ -1216,13 +1216,13 @@ Inputs:
 
 ### method center.\_\_repr\_\_
 
-**\_\_repr\_\_():** ([source](https://github.com/matomatical/matthewplotlib/blob/main/matthewplotlib/plots.py#L1609))
+**\_\_repr\_\_():** ([source](https://github.com/matomatical/matthewplotlib/blob/main/matthewplotlib/plots.py#L1611))
 
 ---
 
 ### function save\_animation
 
-**save\_animation(plots: Sequence[plot], filename: str, upscale: int, downscale: int, bgcolor: ColorLike | None, fps: int, repeat: bool):** ([source](https://github.com/matomatical/matthewplotlib/blob/main/matthewplotlib/plots.py#L1620))
+**save\_animation(plots: Sequence[plot], filename: str, upscale: int, downscale: int, bgcolor: ColorLike | None, fps: int, repeat: bool):** ([source](https://github.com/matomatical/matthewplotlib/blob/main/matthewplotlib/plots.py#L1622))
 
 Supply a list of plots and a filename and this method will create an
 animated gif.

examples/colormaps.py

@@ -21,23 +21,23 @@
     mp.text("test images:"),
     mp.hstack(
         mp.border(
-            mp.text("linspace(0,1,256")
-            / mp.image(im_continuous),
+            mp.image(im_continuous),
+            title="linspace(0,1,256",
         ),
         mp.border(
-            mp.text("arange(256)/16")
-            / mp.image(im_discrete16 / 16),
+            mp.image(im_discrete16 / 16),
+            title="arange(256)/16",
         ),
         mp.border(
-            mp.text("arange(256)/25.6")
-            / mp.image(im_discrete10 / 10),
+            mp.image(im_discrete10 / 10),
+            title="arange(256)/25.6",
         )
     ),
     mp.text("continuous colormaps:"),
     mp.wrap(*[
         mp.border(
-            mp.text(c.__name__)
-            / mp.image(im_continuous, colormap=c),
+            mp.image(im_continuous, colormap=c),
+            title=c.__name__,
         )
         for c in [
             mp.reds, mp.greens, mp.blues, mp.rainbow,
@@ -48,14 +48,14 @@
     mp.text("discrete colormaps:"),
     mp.wrap(*[
         mp.border(
-            mp.text(c.__name__)
-            / mp.image(im_discrete16, colormap=c),
+            mp.image(im_discrete16, colormap=c),
+            title=c.__name__,
         )
         for c in [ mp.sweetie16, mp.pico8 ]
     ], *[
         mp.border(
-            mp.text(c.__name__)
-            / mp.image(im_discrete10, colormap=c),
+            mp.image(im_discrete10, colormap=c),
+            title=c.__name__,
         )
         for c in [ mp.tableau, mp.nouveau ]
     ], cols=4),

images/colormaps.png

@@ -1250,11 +1250,13 @@ class border(plot):
     def __init__(
         self,
         plot: plot,
+        title: str = "",
         style: BoxStyle = BoxStyle.ROUND,
         color: ColorLike | None = None,
     ):
         chars = unicode_box(
             chars=plot.chars,
+            title=title,
             style=style,
             fgcolor=color,
         )