Skip to content

Commit 30ef9c4

Browse files
weiji14seisman
andcommitted
Proofread edits to subplot round 4
Co-Authored-By: Dongdong Tian <seisman.info@gmail.com>
1 parent d16de28 commit 30ef9c4

File tree

2 files changed

+23
-23
lines changed

2 files changed

+23
-23
lines changed

examples/tutorials/subplots.py

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,7 @@
207207
fig.basemap(
208208
region=[0, 5, 0, 5], projection="X?", frame=["af", "WSne"], panel=[0, 1]
209209
)
210-
# Move the plot origin upward by 1 cm
210+
# Move plot origin by 1 cm above the height of the entire figure
211211
fig.shift_origin(yshift="h+1c")
212212
# Top row, one subplot
213213
with fig.subplot(nrows=1, ncols=1, figsize=("15c", "3c"), autolabel="a)"):
@@ -221,12 +221,12 @@
221221
###############################################################################
222222
#
223223
# We start by drawing the bottom two subplots, setting ``autolabel="b)"`` so
224-
# that the subplots are labelled 'b)' and 'c)'. Then, we plot a single subplot
225-
# on the top row by using ``fig.subplot(..., yshift="h+1c")`` which shifts the
226-
# plot origin 1 cm above the **h**\ eight of the entire figure that is
227-
# currently plotted (i.e. the bottom row subplots). You may need to adjust this
228-
# ``yshift`` parameter to make your plot look nice. This top row uses
229-
# ``autolabel="a)"``, and we also plotted some text inside. Note that
224+
# that the subplots are labelled 'b)' and 'c)'. Next, we use
225+
# :meth:`pygmt.Figure.shift_origin` to move the plot origin 1 cm above the
226+
# **h**\ eight of the entire figure that is currently plotted (i.e. the bottom
227+
# row subplots). A single subplot is then plotted on the top row. You may need
228+
# to adjust the ``yshift`` parameter to make your plot look nice. This top row
229+
# uses ``autolabel="a)"``, and we also plotted some text inside. Note that
230230
# ``projection="X?"`` was used to let GMT automatically determine the size of
231231
# the subplot according to the size of the subplot area.
232232

pygmt/src/subplot.py

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -67,22 +67,22 @@ def subplot(self, nrows=1, ncols=1, **kwargs):
6767
Specify automatic tagging of each subplot. Append either a number or
6868
letter [a]. This sets the tag of the first, top-left subplot and others
6969
follow sequentially. Surround the number or letter by parentheses on
70-
any side if these should be typeset as part of the tag. Use **+j|J**\
71-
*refpoint* to specify where the tag should be placed in the subplot
72-
[TL]. Note: **+j** sets the justification of the tag to *refpoint*
73-
(suitable for interior tags) while **+J** instead selects the mirror
74-
opposite (suitable for exterior tags). Append **+c**\ *dx*\[/*dy*] to
75-
set the clearance between the tag and a surrounding text box requested
76-
via **+g** or **+p** [3p/3p, i.e., 15% of the :gmt-term:`FONT_TAG` size
77-
dimension]. Append **+g**\ *fill* to paint the tag's text box with
78-
*fill* [no painting]. Append **+o**\ *dx*\ [/*dy*] to offset the tag's
79-
reference point in the direction implied by the justification [4p/4p,
80-
i.e., 20% of the :gmt-term:`FONT_TAG` size]. Append **+p**\ *pen* to
81-
draw the outline of the tag's text box using selected *pen* [no
82-
outline]. Append **+r** to typeset your tag numbers using lowercase
83-
Roman numerals; use **+R** for uppercase Roman numerals [Arabic
84-
numerals]. Append **+v** to increase tag numbers vertically down
85-
columns [horizontally across rows].
70+
any side if these should be typeset as part of the tag. Use
71+
**+j**\|\ **J**\ *refpoint* to specify where the tag should be placed
72+
in the subplot [TL]. Note: **+j** sets the justification of the tag to
73+
*refpoint* (suitable for interior tags) while **+J** instead selects
74+
the mirror opposite (suitable for exterior tags). Append
75+
**+c**\ *dx*\[/*dy*] to set the clearance between the tag and a
76+
surrounding text box requested via **+g** or **+p** [3p/3p, i.e., 15%
77+
of the :gmt-term:`FONT_TAG` size dimension]. Append **+g**\ *fill* to
78+
paint the tag's text box with *fill* [no painting]. Append
79+
**+o**\ *dx*\ [/*dy*] to offset the tag's reference point in the
80+
direction implied by the justification [4p/4p, i.e., 20% of the
81+
:gmt-term:`FONT_TAG` size]. Append **+p**\ *pen* to draw the outline of
82+
the tag's text box using selected *pen* [no outline]. Append **+r** to
83+
typeset your tag numbers using lowercase Roman numerals; use **+R** for
84+
uppercase Roman numerals [Arabic numerals]. Append **+v** to increase
85+
tag numbers vertically down columns [horizontally across rows].
8686
{B}
8787
clearance : str or list
8888
[*side*]\ *clearance*.

0 commit comments

Comments
 (0)