DOC: Add example to CenteredNorm behavior change

greglucas · greglucas · commit 94dc568721e4 · 2022-11-17T14:37:44.000-07:00
diff --git a/doc/api/next_api_changes/behavior/24132-GL.rst b/doc/api/next_api_changes/behavior/24132-GL.rst
@@ -1,8 +1,29 @@
 ``CenteredNorm`` halfrange is not modified when vcenter changes
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Previously, the halfrange would expand in proportion to the
-amount that vcenter was moved away from either vmin or vmax. Now,
-the halfrange will not be updated when vcenter is changed. If the
-halfrange also needs to be updated, one can set the halfrange
-manually or call autoscale() after setting vcenter.
+Previously, the **halfrange** would expand in proportion to the
+amount that **vcenter** was moved away from either **vmin** or **vmax**.
+Now, the halfrange remains fixed when vcenter is changed, and **vmin** and
+**vmax** are updated based on the **vcenter** and **halfrange** values.
+
+For example, this is what the values were when changing vcenter previously.
+
+.. code-block::
+
+    norm = CenteredNorm(vcenter=0, halfrange=1)
+    # Move vcenter up by one
+    norm.vcenter = 1
+    # updates halfrange and vmax (vmin stays the same)
+    # norm.halfrange == 2, vmin == -1, vmax == 3
+
+and now, with that same example
+
+.. code-block::
+
+    norm = CenteredNorm(vcenter=0, halfrange=1)
+    norm.vcenter = 1
+    # updates vmin and vmax (halfrange stays the same)
+    # norm.halfrange == 1, vmin == 0, vmax == 2
+
+The **halfrange** can be set manually or ``norm.autoscale()``
+can be used to autmatically set the limits after setting **vcenter**.
