Skip to content

Commit 328f373

Browse files
authored
grdpaste: Improve the documentation (#8897)
1 parent 2fbd1ff commit 328f373

1 file changed

Lines changed: 12 additions & 12 deletions

File tree

doc/rst/source/grdpaste.rst

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ Synopsis
1212

1313
.. include:: common_SYN_OPTs.rst_
1414

15-
**gmt grdpaste** *file_a.nc file_b.nc*
16-
|-G|\ *outfile.nc*
15+
**gmt grdpaste** *grid_a grid_b*
16+
|-G|\ *outgrid*
1717
[ |-S| ]
1818
[ |SYN_OPT-V| ]
1919
[ |SYN_OPT-f| ]
@@ -24,9 +24,9 @@ Synopsis
2424
Description
2525
-----------
2626

27-
**grdpaste** will combine *file_a.nc* and *file_b.nc* into
28-
*outfile.nc* by pasting them together along their common edge. Files
29-
*file_a.nc* and *file_b.nc* must have the same grid spacings and registration, and must have one
27+
**grdpaste** will combine *grid_a* and *grid_b* into
28+
*outgrid* by pasting them together along their common edge. Files
29+
*grid_a* and *grid_b* must have the same grid spacings and registration, and must have one
3030
edge in common. If in doubt, check with :doc:`grdinfo` and use :doc:`grdcut`
3131
and/or :doc:`grdsample` if necessary to prepare the edge joint. **Note**: For
3232
geographical grids, you may have to use **-f** to handle periodic longitudes
@@ -36,14 +36,14 @@ For stitching multiple grids, see :doc:`grdblend` instead.
3636
Required Arguments
3737
------------------
3838

39-
*file_a.nc*
39+
*grid_a*
4040
One of two files to be pasted together.
41-
*file_b.nc*
41+
*grid_b*
4242
The other of two files to be pasted together.
4343

4444
.. _-G:
4545

46-
**-G**\ *outfile.nc*
46+
**-G**\ *outgrid*
4747
The name for the combined output. (See :ref:`Grid File Formats <grd_inout_full>`).
4848

4949
Optional Arguments
@@ -54,7 +54,7 @@ Optional Arguments
5454
**-S**
5555
Just prints a code number and a description of the sides at which the grids are pasted.
5656
No pasting actually happens. -G is ignored. This option is useful for externals that want to
57-
reimplement the grdpaste utility since it doesn't work form them (*e.g.* Julia and GMTMEX).
57+
reimplement the grdpaste utility since it doesn't work for them (*e.g.* Julia and GMTMEX).
5858

5959
.. |Add_-V| replace:: |Add_-V_links|
6060
.. include:: explain_-V.rst_
@@ -71,13 +71,13 @@ Examples
7171

7272
.. include:: explain_example.rst_
7373

74-
Suppose file_a.nc is 150E - 180E and 0 - 30N, and file_b.nc is 150E -
75-
180E, -30S - 0, then you can make outfile.nc which will be 150 - 180 and
74+
Suppose grid_a.nc is 150E - 180E and 0 - 30N, and grid_b.nc is 150E -
75+
180E, -30S - 0, then you can make outgrid.nc which will be 150 - 180 and
7676
-30S - 30N by:
7777

7878
::
7979

80-
gmt grdpaste file_a.nc file_b.nc -Goutfile.nc -V -fg
80+
gmt grdpaste grid_a.nc grid_b.nc -Goutgrid.nc -V -fg
8181

8282
See Also
8383
--------

0 commit comments

Comments
 (0)