Skip to content

Commit 61781e4

Browse files
authored
Replace "module" by "method" (#1858)
1 parent a1924e8 commit 61781e4

File tree

14 files changed

+26
-26
lines changed

14 files changed

+26
-26
lines changed

doc/contributing.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -405,9 +405,9 @@ When editing documentation, use the following standards to demonstrate the examp
405405

406406
The API reference is manually assembled in `doc/api/index.rst`.
407407
The *autodoc* sphinx extension will automatically create pages for each
408-
function/class/module listed there.
408+
function/class/module/method listed there.
409409

410-
You can reference functions, classes, methods, and modules from anywhere
410+
You can reference functions, classes, modules, and methods from anywhere
411411
(including docstrings) using:
412412

413413
- <code>:func:\`package.module.function\`</code>
@@ -435,7 +435,7 @@ For GMT configuration parameters, an example is
435435
{gmt-term}`https://docs.generic-mapping-tools.org/latest/gmt.conf#term-COLOR_FOREGROUND <COLOR_FOREGROUND>`.
436436

437437
Sphinx will create a link to the automatically generated page for that
438-
function/class/module.
438+
function/class/module/method.
439439

440440
## Contributing Code
441441

@@ -500,7 +500,7 @@ Tests also help us be confident that we won't break your code in the future.
500500

501501
When writing tests, don't test everything that the GMT function already tests, such as
502502
the every unique combination arguments. An exception to this would be the most popular
503-
modules, such as `plot` and `basemap`. The highest priority for tests should be the
503+
methods, such as `plot` and `basemap`. The highest priority for tests should be the
504504
Python-specific code, such as numpy, pandas, and xarray objects and the virtualfile
505505
mechanism.
506506

doc/maintenance.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -254,7 +254,7 @@ publishing the actual release notes at https://www.pygmt.org/latest/changes.html
254254
typo fixes, CI configuration, test updates due to GMT releases, etc).
255255
5. Sort the items within each section (i.e., New Features, Enhancements, etc.)
256256
such that similar items are located near each other (e.g., new wrapped
257-
modules, gallery examples, API docs changes) and entries within each group
257+
modules and methods, gallery examples, API docs changes) and entries within each group
258258
are alphabetical.
259259
6. Move a few important items from the main sections to the highlights section.
260260
7. Edit the list of people who contributed to the release, linking to their

examples/gallery/lines/vector_heads_tails.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
Vector heads and tails
33
----------------------
44
5-
Many modules in PyGMT allow plotting vectors with individual
5+
Many methods in PyGMT allow plotting vectors with individual
66
heads and tails. For this purpose, several modifiers may be appended to
77
the corresponding vector-producing parameters for specifying the placement
88
of vector heads and tails, their shapes, and the justification of the vector.
@@ -21,7 +21,7 @@
2121
**+h**\ *shape* (e.g. ``+h0.5``).
2222
2323
For further modifiers see the *Vector Attributes* subsection of the
24-
corresponding module.
24+
corresponding method.
2525
2626
In the following we use the :meth:`pygmt.Figure.plot` method to plot vectors
2727
with individual heads and tails. We must specify the modifiers (together with

examples/get-started/README.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,5 +13,5 @@ This tutorial assumes that PyGMT has been successfully
1313

1414
This tutorial will progressively cover PyGMT plotting concepts, and later
1515
examples will use concepts explained in previous examples. It will not
16-
cover all PyGMT modules.
16+
cover all PyGMT methods.
1717

examples/get-started/first_figure.py

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44
55
This tutorial page covers the basics of creating a figure using PyGMT - a
66
Python wrapper for the Generic Mapping Tools (GMT). It will only use
7-
the ``coast`` module for plotting. Later examples will address other PyGMT
8-
modules.
7+
the ``coast`` method for plotting. Later examples will address other PyGMT
8+
methods.
99
"""
1010

1111
###############################################################################
@@ -21,7 +21,7 @@
2121
# Loading the library
2222
# -------------------
2323
#
24-
# The first step is to import ``pygmt``. All modules and figure generation is
24+
# The first step is to import ``pygmt``. All methods and figure generation is
2525
# accessible from the :mod:`pygmt` top level package.
2626

2727
# sphinx_gallery_thumbnail_number = 4
@@ -38,14 +38,14 @@
3838

3939
###############################################################################
4040
# To add to a plot object (``fig`` in this example), the PyGMT module is used
41-
# as a method on the class. This example will use the module ``coast``, which
42-
# can be used to create a map without any other modules or external data. The
43-
# ``coast`` module plots the coastlines, borders, and bodies of water using a
44-
# database that is included in GMT.
41+
# as a method on the class. This example will use the ``coast`` method, which
42+
# can be used to create a map without any other methods, modules or external
43+
# data. The ``coast`` method plots the coastlines, borders, and bodies of water
44+
# using a database that is included in GMT.
4545
#
4646
# First, a region for the figure must be selected. This example will plot some
4747
# of the coast of Maine in the northeastern US. A Python list can be passed to
48-
# the ``region`` argument with the minimum and maximum X-values (longitude)
48+
# the ``region`` parameter with the minimum and maximum X-values (longitude)
4949
# and the minimum and maximum Y-values (latitude). For this example, the
5050
# minimum (bottom left) coordinates are (N43.75, W69) and the maximum (top
5151
# right) coordinates are (N44.75, W68). Negative values can be passed for

examples/projections/README.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ Projections
22
===========
33

44
PyGMT support many map projections. Use the ``projection`` parameter to specify which
5-
one you want to use in all plotting modules. The projection is specified by a one
5+
one you want to use in all plotting methods. The projection is specified by a one
66
letter code along with (sometimes optional) reference longitude and latitude and the
77
width of the map (for example, **A**\ *lon0/lat0*\ [*/horizon*\ ]\ */width*). The map
88
height is determined based on the region and projection.

examples/tutorials/basics/frames.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222

2323
###############################################################################
2424
# To add the default GMT frame to the plot, use ``frame="f"`` in
25-
# :meth:`pygmt.Figure.basemap` or any other plotting module:
25+
# :meth:`pygmt.Figure.basemap` or any other plotting method:
2626

2727
fig = pygmt.Figure()
2828
fig.coast(shorelines="1/0.5p", region=[-180, 180, -60, 60], projection="M25c")

pygmt/src/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
"""
2-
Source code for PyGMT modules.
2+
Source code for PyGMT methods.
33
"""
44
# pylint: disable=import-outside-toplevel
55

pygmt/src/grd2cpt.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ def grd2cpt(grid, **kwargs):
3333
r"""
3434
Make GMT color palette tables from a grid file.
3535
36-
This is a module that will help you make static color palette tables
36+
This is a method that will help you make static color palette tables
3737
(CPTs). By default, the CPT will simply be saved to the current session,
3838
but you can use ``output`` to save it to a file. The CPT is based on an
3939
existing dynamic master CPT of your choice, and the mapping from data value

pygmt/src/grdimage.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ def grdimage(self, grid, **kwargs):
133133
ambient light). Alternatively, derive an intensity grid from the input
134134
data grid via a call to :meth:`pygmt.grdgradient`; append
135135
**+a**\ *azimuth*, **+n**\ *args*, and **+m**\ *ambient* to specify
136-
azimuth, intensity, and ambient arguments for that module, or just give
136+
azimuth, intensity, and ambient arguments for that method, or just give
137137
**+d** to select the default arguments (``+a-45+nt1+m0``). If you want
138138
a more specific intensity scenario then run :meth:`pygmt.grdgradient`
139139
separately first. If we should derive intensities from another file

0 commit comments

Comments
 (0)