Make raw strings

Author: Meghan Jones

pygmt/src/basemap.py

@@ -33,7 +33,7 @@
 )
 @kwargs_to_strings(R="sequence", c="sequence_comma", p="sequence")
 def basemap(self, **kwargs):
-    """
+    r"""
     Plot base maps and frames for the figure.
 
     Creates a basic or fancy basemap with axes, fill, and titles. Several

pygmt/src/colorbar.py

@@ -28,7 +28,7 @@
     R="sequence", G="sequence", I="sequence", c="sequence_comma", p="sequence"
 )
 def colorbar(self, **kwargs):
-    """
+    r"""
     Plot a gray or color scale-bar on maps.
 
     Both horizontal and vertical scales are supported. For CPTs with

pygmt/src/contour.py

@@ -36,7 +36,7 @@
 )
 @kwargs_to_strings(R="sequence", c="sequence_comma", i="sequence_comma", p="sequence")
 def contour(self, x=None, y=None, z=None, data=None, **kwargs):
-    """
+    r"""
     Contour table data by direct triangulation.
 
     Takes a matrix, (x,y,z) pairs, or a file name as input and plots lines,

pygmt/src/grdcontour.py

@@ -38,7 +38,7 @@
     R="sequence", L="sequence", A="sequence_plus", c="sequence_comma", p="sequence"
 )
 def grdcontour(self, grid, **kwargs):
-    """
+    r"""
     Convert grids or images to contours and plot them on maps.
 
     Takes a grid file name or an xarray.DataArray object as input.

pygmt/src/grdimage.py

@@ -39,7 +39,7 @@
 )
 @kwargs_to_strings(R="sequence", c="sequence_comma", p="sequence")
 def grdimage(self, grid, **kwargs):
-    """
+    r"""
     Project and plot grids or images.
 
     Reads a 2-D grid file and produces a gray-shaded (or colored) map by

pygmt/src/grdview.py

@@ -39,7 +39,7 @@
 )
 @kwargs_to_strings(R="sequence", c="sequence_comma", p="sequence")
 def grdview(self, grid, **kwargs):
-    """
+    r"""
     Create 3-D perspective image or surface mesh from a grid.
 
     Reads a 2-D grid file and produces a 3-D perspective plot by drawing a

pygmt/src/image.py

@@ -21,7 +21,7 @@
 )
 @kwargs_to_strings(R="sequence", c="sequence_comma", p="sequence")
 def image(self, imagefile, **kwargs):
-    """
+    r"""
     Place images or EPS files on maps.
 
     Reads an Encapsulated PostScript file or a raster image file and plots

pygmt/src/legend.py

@@ -28,7 +28,7 @@
 )
 @kwargs_to_strings(R="sequence", c="sequence_comma", p="sequence")
 def legend(self, spec=None, position="JTR+jTR+o0.2c", box="+gwhite+p1p", **kwargs):
-    """
+    r"""
     Plot legends on maps.
 
     Makes legends that can be overlaid on maps. Reads specific

pygmt/src/logo.py

@@ -22,7 +22,7 @@
 )
 @kwargs_to_strings(R="sequence", c="sequence_comma", p="sequence")
 def logo(self, **kwargs):
-    """
+    r"""
     Plot the GMT logo.
 
     By default, the GMT logo is 2 inches wide and 1 inch high and

pygmt/src/plot.py

@@ -44,7 +44,7 @@
 )
 @kwargs_to_strings(R="sequence", c="sequence_comma", i="sequence_comma", p="sequence")
 def plot(self, x=None, y=None, data=None, sizes=None, direction=None, **kwargs):
-    """
+    r"""
     Plot lines, polygons, and symbols in 2-D.
 
     Takes a matrix, (x,y) pairs, or a file name as input and plots lines,