update .rst

stevezhang · stevezhang · commit 5770305fa065 · 2023-05-03T16:58:23.000-04:00
diff --git a/doc/api/next_api_changes/behavior/25775-HZ.rst b/doc/api/next_api_changes/behavior/25775-HZ.rst
@@ -1,43 +1,42 @@
 Support customizing antialiasing for text and annotation
-~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-APIs:
-https://matplotlib.org/stable/api/text_api.html#matplotlib.text.Text
-https://matplotlib.org/stable/api/_as_gen/matplotlib.pyplot.annotate.html
 
-Text objects and annotation objects now support parameter `antialiased`.
-When `antialiased` is set to `True`, antialiasing will be applied to the text.
-When `antialiased` is set to `False`, antialiasing will be applied to the text.
-When `antialiased` is not specified, it will use the value from `rcParams['text.antialiased']`.
+
+``matplotlib.pyplot.annotate()`` and ``matplotlib.pyplot.text()`` now support parameter ``antialiased``.
+When ``antialiased`` is set to ``True``, antialiasing will be applied to the text.
+When ``antialiased`` is set to ``False``, antialiasing will be applied to the text.
+When ``antialiased`` is not specified, it will use the value from ``rcParams['text.antialiased']``.
 
 Examples:
-```
-mpl.text.Text(.5, .5, "foo\nbar", antialiased=True)
-plt.text(0.5, 0.5, '6 inches x 2 inches', antialiased=True)
-ax.annotate('local max', xy=(2, 1), xytext=(3, 1.5), antialiased=False)
-```
 
-If the text contains math expression, then anaialiasing will be applied by `rcParams['text.antialiased']` and `antialiased` will have no effect
+.. code-block::
+
+    mpl.text.Text(.5, .5, "foo\nbar", antialiased=True)
+    plt.text(0.5, 0.5, '6 inches x 2 inches', antialiased=True)
+    ax.annotate('local max', xy=(2, 1), xytext=(3, 1.5), antialiased=False)
+
+If the text contains math expression, then anaialiasing will be applied by ``rcParams['text.antialiased']`` and ``antialiased`` will have no effect
 This applies to the whole text.
 Examples:
-```
-plt.text(0.5, 0.25, r"$I'm \sqrt{x}$", antialiased=False)
-```
 
-Also note that antialiasing for coordinate axes will be set with `rcParams['text.antialiased']` when they are created and cannot be changed afterwards.
+.. code-block::
 
-With this new feature, you may want to make sure that you are creating and saving/showing the figure under the same context:
-```
-# previously this was a no-op, now it is what works
-with rccontext(text.antialiased=False):
-    fig, ax = plt.subplots()
-    ax.annotate('local max', xy=(2, 1), xytext=(3, 1.5))
-    fig.savefig('/tmp/test.png')
+    plt.text(0.5, 0.25, r"$I'm \sqrt{x}$", antialiased=False)
 
+Also note that antialiasing for coordinate axes will be set with ``rcParams['text.antialiased']`` when they are created and cannot be changed afterwards.
 
-# previously this had an effect, now this is a no-op
-fig, ax = plt.subplots()
-ax.annotate('local max', xy=(2, 1), xytext=(3, 1.5))
-with rccontext(text.antialiased=False):
-    fig.savefig('/tmp/test.png')
-```
+With this new feature, you may want to make sure that you are creating and saving/showing the figure under the same context::
+
+    # previously this was a no-op, now it is what works
+    with rccontext(text.antialiased=False):
+        fig, ax = plt.subplots()
+        ax.annotate('local max', xy=(2, 1), xytext=(3, 1.5))
+        fig.savefig('/tmp/test.png')
+
+
+    # previously this had an effect, now this is a no-op
+    fig, ax = plt.subplots()
+    ax.annotate('local max', xy=(2, 1), xytext=(3, 1.5))
+    with rccontext(text.antialiased=False):
+        fig.savefig('/tmp/test.png')
