Skip to content

Commit d33e5ac

Browse files
authored
DOC: Make usage of "lowercase" and "uppercase" consistent across all docs (#3756)
1 parent c7198e6 commit d33e5ac

17 files changed

+25
-24
lines changed

doc/techref/patterns.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ image raster file. The former will result in one of the 90 predefined 64x64 bit-
1111
provided by GMT (see the figure below). The latter allows the user to create customized,
1212
repeating images using image raster files.
1313

14-
By specifying upper case **P** instead of **p** the image will be bit-reversed, i.e.,
14+
By specifying uppercase **P** instead of **p** the image will be bit-reversed, i.e.,
1515
white and black areas will be interchanged (only applies to 1-bit images or predefined
1616
bit-image patterns). For these patterns and other 1-bit images one may specify
1717
alternative **b**ackground and **f**oreground colors (by appending **+b**_color_ and/or

examples/gallery/basemaps/double_y_axes.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
The ``frame`` parameter of the plotting methods of the :class:`pygmt.Figure`
66
class can control which axes should be plotted and optionally show annotations,
77
tick marks, and gridlines. By default, all 4 axes are plotted, along with
8-
annotations and tick marks (denoted **W**, **S**, **E**, **N**). Lower case
8+
annotations and tick marks (denoted **W**, **S**, **E**, **N**). Lowercase
99
versions (**w**, **s**, **e**, **n**) can be used to denote to only plot the
1010
axes with tick marks. We can also only plot the axes without annotations and
1111
tick marks using **l** (left axis), **r** (right axis), **t** (top axis),

examples/gallery/embellishments/scalebar.py

+3-2
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,9 @@
1212
- **g**: Give map coordinates as *longitude*\/\ *latitude*.
1313
- **j**\|\ **J**: Specify a two-character (order independent) code.
1414
Choose from vertical **T**\(op), **M**\(iddle), or **B**\(ottom) and
15-
horizontal **L**\(eft), **C**\(entre), or **R**\(ight). Lower / upper
16-
case **j** / **J** mean inside / outside of the map bounding box.
15+
horizontal **L**\(eft), **C**\(entre), or **R**\(ight). Lower /
16+
uppercase **j** / **J** mean inside / outside of the map bounding
17+
box.
1718
- **n**: Give normalized bounding box coordinates as *nx*\/\ *ny*.
1819
- **x**: Give plot coordinates as *x*\/\ *y*.
1920

examples/gallery/images/cross_section.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737

3838
# Add a colorbar for the elevation
3939
fig.colorbar(
40-
# Place the colorbar inside the plot (lower-case "j") in the Bottom Right (BR)
40+
# Place the colorbar inside the plot (lowercase "j") in the Bottom Right (BR)
4141
# corner with an offset ("+o") of 0.7 centimeters and 0.3 centimeters in x or y
4242
# directions, respectively; move the x label above the horizontal colorbar ("+ml")
4343
position="jBR+o0.7c/0.8c+h+w5c/0.3c+ml",

examples/gallery/lines/decorated_lines.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@
5151
"~d1c:+sd0.5c+gtan+p1p,black+n-0.2c/0.1c",
5252
# Give the number of equally spaced symbols by using "n" instead of "d"
5353
"~n6:+sn0.5c+gtan+p1p,black",
54-
# Use upper-case "N" to have symbols at the start and end of the line
54+
# Use uppercase "N" to have symbols at the start and end of the line
5555
"~N6:+sh0.5c+gtan+p1p,black",
5656
# Suppress the main decorated line by appending "+i"
5757
"~d1c:+sg0.5c+gtan+p1p,black+i",

examples/gallery/lines/quoted_lines.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
"qd1c:+ltext+i",
3434
# Give the number of equally spaced labels by using "n" instead of "d"
3535
"qn5:+ltext",
36-
# Use upper-case "N" to have labels at the start and end of the line
36+
# Use uppercase "N" to have labels at the start and end of the line
3737
"qN5:+ltext",
3838
# To only plot a label at the start of the line use "N-1"
3939
"qN-1:+ltext",

examples/gallery/symbols/multi_parameter_symbols.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
# directions given in degrees counter-clockwise from horizontal. Append **+i** and the
3434
# desired value to apply an inner diameter.
3535
#
36-
# Upper-case versions **E**, **J**, and **W** are similar to **e**, **j**, and **w**
36+
# Uppercase versions **E**, **J**, and **W** are similar to **e**, **j**, and **w**
3737
# but expect geographic azimuths and distances.
3838

3939
fig = pygmt.Figure()

examples/projections/cyl/cyl_oblique_mercator.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
1010
The projection is set with **o** or **O**. There are three different specification
1111
ways (**a**\|\ **A**, **b**\|\ **B**, **c**\|\ **C**) available. For all three
12-
definitions, the upper case letter mean the projection pole is set in the southern
12+
definitions, the uppercase letter mean the projection pole is set in the southern
1313
hemisphere [Default is northern hemisphere]. Align the y-axis with the optional
1414
modifier **+v**. The figure size is set with *scale* or *width*.
1515
"""

examples/projections/nongeo/cartesian_linear.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
55
**X**\ *width*\ [/*height*] or **x**\ *x-scale*\ [/*y-scale*]
66
7-
Give the *width* of the figure and the optional *height*. The lower-case version
7+
Give the *width* of the figure and the optional *height*. The lowercase version
88
**x** is similar to **X** but expects an *x-scale* and an optional *y-scale*.
99
1010
The Cartesian linear projection is primarily designed for regular floating point

examples/projections/nongeo/cartesian_logarithmic.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
**x**\ *x-scale*\ [**l**][/*y-scale*\ [**l**]]
77
88
Give the *width* of the figure and the optional *height*.
9-
The lower-case version **x** is similar to **X** but expects
9+
The lowercase version **x** is similar to **X** but expects
1010
an *x-scale* and an optional *y-scale*.
1111
Each axis with a logarithmic transformation requires **l** after
1212
its size argument.

examples/projections/nongeo/cartesian_power.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
**x**\ *x-scale*\ [**p**\ *pvalue*][/*y-scale*\ [**p**\ *pvalue*]]
77
88
Give the *width* of the figure and the optional argument *height*.
9-
The lower-case version **x** is similar to **X** but expects
9+
The lowercase version **x** is similar to **X** but expects
1010
an *x-scale* and an optional *y-scale*.
1111
Each axis with a power transformation requires **p** and the exponent
1212
for that axis after its size argument.

examples/projections/nongeo/polar.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
1313
Limits are set via the ``region`` parameter
1414
([*theta_min*, *theta_max*, *radius_min*, *radius_max*]). When using **P**\ *width* you
15-
have to give the *width* of the figure. The lower-case version **p** is similar to **P**
15+
have to give the *width* of the figure. The lowercase version **p** is similar to **P**
1616
but expects a *scale* instead of a width (**p**\ *scale*).
1717
1818
The following customizing modifiers are available:

examples/tutorials/basics/frames.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -90,9 +90,9 @@
9090
# :meth:`pygmt.Figure.basemap`. The map boundaries (or plot axes) are named as
9191
# West/west/left (**W**, **w**, **l**), South/south/bottom
9292
# (**S**, **s**, **b**), North/north/top (**N**, **n**, **t**), and
93-
# East/east/right (**E**, **e**, **r**) sides of a figure. If an upper-case
93+
# East/east/right (**E**, **e**, **r**) sides of a figure. If an uppercase
9494
# letter (**W**, **S**, **N**, **E**) is passed, the axis is plotted with
95-
# tick marks and annotations. The lower-case version
95+
# tick marks and annotations. The lowercase version
9696
# (**w**, **s**, **n**, **e**) plots the axis only with tick marks.
9797
# To only plot the axis pass **l**, **b**, **t**, **r**. By default
9898
# (``frame=True`` or ``frame="af"``), the West and the South axes are

pygmt/helpers/decorators.py

+3-3
Original file line numberDiff line numberDiff line change
@@ -119,13 +119,13 @@
119119
criteria.
120120
121121
- **x**\|\ **X**: define a gap when there is a large enough
122-
change in the x coordinates (upper case to use projected
122+
change in the x coordinates (uppercase to use projected
123123
coordinates).
124124
- **y**\|\ **Y**: define a gap when there is a large enough
125-
change in the y coordinates (upper case to use projected
125+
change in the y coordinates (uppercase to use projected
126126
coordinates).
127127
- **d**\|\ **D**: define a gap when there is a large enough
128-
distance between coordinates (upper case to use projected
128+
distance between coordinates (uppercase to use projected
129129
coordinates).
130130
- **z**: define a gap when there is a large enough change in
131131
the z data. Use **+c**\ *col* to change the z data column

pygmt/src/filter1d.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ def filter1d(
7575
- **u**: upper (absolute). Return maximum of all values.
7676
- **U**: upper. Return maximum of all negative values only.
7777
78-
Upper case type **B**, **C**, **G**, **M**, **P**, **F** will use
78+
Uppercase type **B**, **C**, **G**, **M**, **P**, **F** will use
7979
robust filter versions: i.e., replace outliers (2.5 L1 scale off
8080
median, using 1.4826 \* median absolute deviation [MAD]) with median
8181
during filtering.

pygmt/src/project.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ def project(
136136
convention : str
137137
Specify the desired output using any combination of **xyzpqrs**, in
138138
any order [Default is **xypqrsz**]. Do not space between the letters.
139-
Use lower case. The output will be columns of values corresponding to
139+
Use lowercase. The output will be columns of values corresponding to
140140
your ``convention``. The **z** flag is special and refers to all
141141
numerical columns beyond the leading **x** and **y** in your input
142142
record. The **z** flag also includes any trailing text (which is

pygmt/src/text.py

+4-4
Original file line numberDiff line numberDiff line change
@@ -138,11 +138,11 @@ def text_( # noqa: PLR0912
138138
**i** for inches, or **p** for points; if not given we consult
139139
:gmt-term:`PROJ_LENGTH_UNIT`) or *%* for a percentage of the font
140140
size. Optionally, use modifier **+t** to set the shape of the text
141-
box when using ``fill`` and/or ``pen``. Append lower case **o**
142-
to get a straight rectangle [Default is **o**]. Append upper case
141+
box when using ``fill`` and/or ``pen``. Append lowercase **o**
142+
to get a straight rectangle [Default is **o**]. Append uppercase
143143
**O** to get a rounded rectangle. In paragraph mode (*paragraph*)
144-
you can also append lower case **c** to get a concave rectangle or
145-
append upper case **C** to get a convex rectangle.
144+
you can also append lowercase **c** to get a concave rectangle or
145+
append uppercase **C** to get a convex rectangle.
146146
fill : str
147147
Set color for filling text boxes [Default is no fill].
148148
offset : str

0 commit comments

Comments
 (0)