Skip to content

Commit 3b14a0e

Browse files
weiji14seisman
andauthored
Fix grdimage docstring formatting
Co-authored-by: Dongdong Tian <[email protected]>
1 parent 8ad8d7c commit 3b14a0e

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

pygmt/base_plotting.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -354,7 +354,7 @@ def grdimage(self, grid, **kwargs):
354354
`grdmath` or `grdhisteq`. A third alternative is available when GMT is
355355
build with GDAL support. Pass **image** which can be an image file
356356
(geo-referenced or not). In this case the image can optionally be
357-
illuminated with the file provided via the **shading** option. Here, if
357+
illuminated with the file provided via the *shading* option. Here, if
358358
image has no coordinates then those of the intensity file will be used.
359359
360360
When using map projections, the grid is first resampled on a new
@@ -394,7 +394,7 @@ def grdimage(self, grid, **kwargs):
394394
information is required. For other output formats you must append
395395
the required GDAL driver. The driver is the driver code name used
396396
by GDAL; see your GDAL installation's documentation for available
397-
drivers. Append a **+coptions** string where options is a list of
397+
drivers. Append a **+c**\ *options* string where options is a list of
398398
one or more concatenated number of GDAL **-co** options. For
399399
example, to write a GeoPDF with the TerraGo format use
400400
``=PDF+cGEO_ENCODING=OGC_BP``. Notes: (1) If a tiff file (.tif) is
@@ -407,9 +407,9 @@ def grdimage(self, grid, **kwargs):
407407
``[r]``
408408
GMT will automatically detect standard image files (Geotiff, TIFF,
409409
JPG, PNG, GIF, etc.) and will read those via GDAL. For very obscure
410-
image formats you may need to explicitly set **img_in**, which
410+
image formats you may need to explicitly set *img_in*, which
411411
specifies that the grid is in fact an image file to be read via
412-
GDAL. Append **r** to assign the region specified by **region**
412+
GDAL. Append **r** to assign the region specified by *region*
413413
to the image. For example, if you have used ``region='d'`` then the
414414
image will be assigned a global domain. This mode allows you to
415415
project a raw image (an image without referencing coordinates).

0 commit comments

Comments
 (0)