Skip to content

Commit cf4c3ce

Browse files
committed
resolve links to api
1 parent 0e4417d commit cf4c3ce

2 files changed

Lines changed: 14 additions & 10 deletions

File tree

docs/first_figure.py

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -178,9 +178,10 @@
178178
series1 = np.sin(time) * np.exp(-time / 5)
179179
series2 = np.cos(time) * np.exp(-time / 5)
180180

181-
# Use a Cartesian panel as the square reference. The map keeps its native
182-
# Robinson aspect while the right-hand plots remain readable in a tall figure.
183-
layout = [[1, 2], [1, 2], [1, 3], [1, 3]]
181+
# The map spans two rows while the right-hand panels stack beside it. With the
182+
# 4:1 column ratio below, the Robinson map keeps its native 2:1 aspect and the
183+
# right-hand panels receive approximately square plotting areas.
184+
layout = [[1, 2], [1, 3]]
184185

185186
# 3. Create the figure
186187
# Apply a Robinson projection only to the first panel.
@@ -190,10 +191,8 @@
190191
share=0,
191192
refnum=2,
192193
refwidth=1.5,
193-
wratios=(3.25, 1),
194-
# The two right-hand axes span rows (0, 1) and (2, 3), respectively.
195-
# Only the middle boundary separates them.
196-
hspace=('0pt', '13em', '0pt'),
194+
wratios=(4, 1),
195+
hspace='13em',
197196
)
198197

199198
# 4. Geographic data

docs/why_ultraplot.py

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -114,9 +114,14 @@
114114
# UltraPlot does not reinvent the wheel—it just makes it easier to steer. A good
115115
# mental model for your workflow looks like this:
116116
#
117-
# * Use standard Matplotlib axes methods (``plot``, ``imshow``, ``scatter``) to draw the data.
118-
# * Use ``axs.format()`` to apply consistent labels, ticks, and styling at the panel level.
119-
# * Use ``fig.format()`` for global aesthetics and unified figure guides (like shared colorbars).
117+
# * Use standard axes methods such as :meth:`~ultraplot.axes.PlotAxes.plot`,
118+
# :meth:`~ultraplot.axes.PlotAxes.imshow`, and
119+
# :meth:`~ultraplot.axes.PlotAxes.scatter` to draw data.
120+
# * Use :meth:`~ultraplot.axes.Axes.format` through ``axs.format()`` to apply
121+
# consistent labels, ticks, and styling at the panel level.
122+
# * Use :meth:`~ultraplot.figure.Figure.format` through ``fig.format()`` for
123+
# global aesthetics, and :meth:`~ultraplot.figure.Figure.colorbar` for a
124+
# shared colorbar.
120125
#
121126
# For a single, fast plot, stick with Matplotlib. When layout scaling and repetitive
122127
# formatting become a chore, let UltraPlot handle the heavy lifting.

0 commit comments

Comments
 (0)