Skip to content

Commit 81aa4bf

Browse files
committed
DOC: improved changelog wording and links
1 parent 3707833 commit 81aa4bf

File tree

1 file changed

+13
-12
lines changed

1 file changed

+13
-12
lines changed

doc/source/changes/version_0_35.rst.inc

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -15,31 +15,32 @@ Syntax changes
1515
Backward incompatible changes
1616
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1717

18-
* Plots made with Array.plot() in a Python script will be shown by default,
19-
unless either the filepath (see below) or ax arguments are used. Shown plots
20-
will open a window and pause the running script until the window is closed by
21-
the user. To revert to the previous behavior, use show=False.
18+
* Plots made with :py:obj:`Array.plot()` in a Python script will be shown by
19+
default, unless either the filepath (see below) or ax arguments are used.
20+
Shown plots will open a window and pause the running script until the window
21+
is closed by the user. To revert to the previous behavior, use show=False.
2222

2323
* Using :py:obj:`CheckedSession`, :py:obj:`CheckedParameters` or :py:obj:`CheckedArray`
2424
now requires to install pydantic >= 2.12 (closes :issue:`1075`).
2525

2626
New features
2727
^^^^^^^^^^^^
2828

29-
* Array.plot now has an ´animate´ argument to produce animated plots. The
30-
argument takes an axis (it also supports several axes but that is rarely
31-
useful) and will create an animation, with one image per label of that axis.
32-
For example,
29+
* :py:obj:`Array.plot()` now has an ``animate`` argument to produce animated
30+
plots. The argument takes an axis (it also supports several axes but that is
31+
rarely useful) and will create an animation, with one image per label of that
32+
axis. For example,
3333

3434
>>> arr.plot.bar(animate='year')
3535

3636
will create an animated bar plot with one frame per year.
3737

38-
* implemented Array.plot `filepath` argument to save plots to a file directly,
39-
without having to use the matplotlib API.
38+
* implemented :py:obj:`Array.plot()` ``filepath`` argument to save plots to a
39+
file directly, without having to use the matplotlib API.
4040

41-
* implemented Array.plot `show` argument to display plots directly, without
42-
having to use the matplotlib API. This is the new default behavior.
41+
* implemented :py:obj:`Array.plot()` ``show`` argument to display plots
42+
directly, without having to use the matplotlib API. This is the new default
43+
behavior, unless a ``filepath`` is given.
4344

4445
* implemented a new kind of plot: `heatmap`. It can be used like this:
4546

0 commit comments

Comments
 (0)