Skip to content

Commit 634a79b

Browse files
DOC: Figure.subplot: Improve docstring for "autolabel" (#4166)
1 parent 2b77309 commit 634a79b

File tree

1 file changed

+22
-21
lines changed

1 file changed

+22
-21
lines changed

pygmt/src/subplot.py

Lines changed: 22 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -72,27 +72,28 @@ def subplot(
7272
7373
autolabel : bool or str
7474
[*autolabel*][**+c**\ *dx*\ [/*dy*]][**+g**\ *fill*][**+j**\|\ **J**\
75-
*refpoint*][**+o**\ *dx*\ [/*dy*]][**+p**\ *pen*][**+r**\|\ **R**]
76-
[**+v**].
77-
Specify automatic tagging of each subplot. Append either a number or
78-
letter [a]. This sets the tag of the first, top-left subplot and others
79-
follow sequentially. Surround the number or letter by parentheses on
80-
any side if these should be typeset as part of the tag. Use
81-
**+j**\|\ **J**\ *refpoint* to specify where the tag should be placed
82-
in the subplot [TL]. **Note**: **+j** sets the justification of the
83-
tag to *refpoint* (suitable for interior tags) while **+J** instead
84-
selects the mirror opposite (suitable for exterior tags). Append
85-
**+c**\ *dx*\[/*dy*] to set the clearance between the tag and a
86-
surrounding text box requested via **+g** or **+p** [3p/3p, i.e., 15%
87-
of the :gmt-term:`FONT_TAG` size dimension]. Append **+g**\ *fill* to
88-
paint the tag's text box with *fill* [no painting]. Append
89-
**+o**\ *dx*\ [/*dy*] to offset the tag's reference point in the
90-
direction implied by the justification [4p/4p, i.e., 20% of the
91-
:gmt-term:`FONT_TAG` size]. Append **+p**\ *pen* to draw the outline of
92-
the tag's text box using selected *pen* [no outline]. Append **+r** to
93-
typeset your tag numbers using lowercase Roman numerals; use **+R** for
94-
uppercase Roman numerals [Arabic numerals]. Append **+v** to increase
95-
tag numbers vertically down columns [horizontally across rows].
75+
*refpoint*][**+o**\ *dx*\ [/*dy*]][**+p**\ *pen*][**+r**\|\ **R**]\ [**+v**].
76+
Specify automatic tagging of each subplot. Append either a number or letter
77+
[Default is ``"a"``]. This sets the tag of the first, top-left subplot and
78+
others follow sequentially. Surround the number or letter by parentheses on
79+
any side if these should be typeset as part of the tag [Default is ``")"``].
80+
Use **+j**\|\ **J** for setting *refpoint* via a
81+
:doc:`2-character justification code </techref/justification_codes>`
82+
to specify where the tag should be placed in the subplot [Default is ``"TL"``
83+
for the Top Left corner]. **Note**: **+j** sets the justification of the tag
84+
to *refpoint* (suitable for interior tags) while **+J** instead selects the
85+
mirror opposite (suitable for exterior tags). Append **+c**\ *dx*\[/*dy*] to
86+
set the clearance between the tag and a surrounding text box requested via
87+
**+g** or **+p** [Default is ``"3p/3p"``, i.e., 15 % of the
88+
:gmt-term:`FONT_TAG` size dimension]. Append **+g**\ *fill* to paint the tag's
89+
text box with *fill* [Default is no fill]. Append **+o**\ *dx*\ [/*dy*] to
90+
offset the tag's reference point in the direction implied by the justification
91+
[Default is ``"4p/4p"``, i.e., 20 % of the :gmt-term:`FONT_TAG` size]. Append
92+
**+p**\ *pen* to draw the outline of the tag's text box using the selected *pen*
93+
[Default is no outline]. Append **+r** to typeset your tag numbers using
94+
lowercase Roman numerals; use **+R** for uppercase Roman numerals [Default is
95+
Arabic numerals]. Append **+v** to increase tag numbers vertically down columns
96+
[Default is horizontally across rows].
9697
{frame}
9798
clearance : str or list
9899
[*side*]\ *clearance*.

0 commit comments

Comments
 (0)