Run "make format" to format all docstrings

Author: seisman

doc/conf.py

@@ -1,7 +1,5 @@
 # -*- coding: utf-8 -*-
-"""
-Sphinx documentation configuration file.
-"""
+"""Sphinx documentation configuration file."""
 # pylint: disable=invalid-name
 
 import datetime

pygmt/__init__.py

@@ -163,7 +163,6 @@ def test(doctest=True, verbose=True, coverage=False, figures=True):
     AssertionError
         If pytest returns a non-zero error code indicating that some tests have
         failed.
-
     """
     import pytest
 

pygmt/base_plotting.py

@@ -1,5 +1,6 @@
 """
 Base class with plot generating commands.
+
 Does not define any special non-GMT methods (savefig, show, etc).
 """
 import contextlib
@@ -51,7 +52,6 @@ def _preprocess(self, **kwargs):  # pylint: disable=no-self-use
         >>> base = BasePlotting()
         >>> base._preprocess(resolution="low")
         {'resolution': 'low'}
-
         """
         return kwargs
 
@@ -78,7 +78,7 @@ def _preprocess(self, **kwargs):  # pylint: disable=no-self-use
     @kwargs_to_strings(R="sequence", p="sequence")
     def coast(self, **kwargs):
         """
-        Plot continents, shorelines, rivers, and borders on maps
+        Plot continents, shorelines, rivers, and borders on maps.
 
         Plots grayshaded, colored, or textured land-masses [or water-masses] on
         maps and [optionally] draws coastlines, rivers, and political
@@ -138,7 +138,6 @@ def coast(self, **kwargs):
         {XY}
         {p}
         {t}
-
         """
         kwargs = self._preprocess(**kwargs)
         with Session() as lib:
@@ -224,7 +223,6 @@ def colorbar(self, **kwargs):
         {XY}
         {p}
         {t}
-
         """
         kwargs = self._preprocess(**kwargs)
         with Session() as lib:
@@ -253,7 +251,7 @@ def colorbar(self, **kwargs):
     @kwargs_to_strings(R="sequence", L="sequence", A="sequence_plus", p="sequence")
     def grdcontour(self, grid, **kwargs):
         """
-        Convert grids or images to contours and plot them on maps
+        Convert grids or images to contours and plot them on maps.
 
         Takes a grid file name or an xarray.DataArray object as input.
 
@@ -469,7 +467,6 @@ def grdimage(self, grid, **kwargs):
         {p}
         {t}
         {x}
-
         """
         kwargs = self._preprocess(**kwargs)
         kind = data_kind(grid, None, None)
@@ -580,7 +577,6 @@ def grdview(self, grid, **kwargs):
         {XY}
         {p}
         {t}
-
         """
         kwargs = self._preprocess(**kwargs)
         kind = data_kind(grid, None, None)
@@ -778,7 +774,6 @@ def plot(self, x=None, y=None, data=None, sizes=None, direction=None, **kwargs):
         {t}
             *transparency* can also be a 1d array to set varying transparency
             for symbols.
-
         """
         kwargs = self._preprocess(**kwargs)
 
@@ -851,7 +846,7 @@ def plot3d(
         self, x=None, y=None, z=None, data=None, sizes=None, direction=None, **kwargs
     ):
         """
-        Plot lines, polygons, and symbols in 3-D
+        Plot lines, polygons, and symbols in 3-D.
 
         Takes a matrix, (x,y,z) triplets, or a file name as input and plots
         lines, polygons, or symbols at those locations in 3-D.
@@ -961,7 +956,6 @@ def plot3d(
         {t}
             *transparency* can also be a 1d array to set varying transparency
             for symbols.
-
         """
         kwargs = self._preprocess(**kwargs)
 
@@ -1083,7 +1077,6 @@ def contour(self, x=None, y=None, z=None, data=None, **kwargs):
         {XY}
         {p}
         {t}
-
         """
         kwargs = self._preprocess(**kwargs)
 
@@ -1159,7 +1152,6 @@ def basemap(self, **kwargs):
         {XY}
         {p}
         {t}
-
         """
         kwargs = self._preprocess(**kwargs)
         if not ("B" in kwargs or "L" in kwargs or "T" in kwargs):
@@ -1216,7 +1208,6 @@ def logo(self, **kwargs):
         {V}
         {XY}
         {t}
-
         """
         kwargs = self._preprocess(**kwargs)
         with Session() as lib:
@@ -1658,8 +1649,8 @@ def set_pointer(data_pointers, spec):
 
         def update_pointers(data_pointers):
             """Updates variables based on the location of data, as the
-            following data can be passed as parameters or it can be
-            contained in `spec`."""
+            following data can be passed as parameters or it can be contained
+            in `spec`."""
             # update all pointers
             longitude = data_pointers["longitude"]
             latitude = data_pointers["latitude"]

pygmt/clib/conversion.py

@@ -1,6 +1,4 @@
-"""
-Functions to convert data types into ctypes friendly formats.
-"""
+"""Functions to convert data types into ctypes friendly formats."""
 import numpy as np
 import pandas as pd
 
@@ -80,7 +78,6 @@ def dataarray_to_matrix(grid):
     [-150.5, -78.5, -80.5, -48.5]
     >>> print(inc)
     [2.0, 2.0]
-
     """
     if len(grid.dims) != 2:
         raise GMTInvalidInput(
@@ -159,7 +156,6 @@ def vectors_to_arrays(vectors):
     >>> data = [[1, 2], (3, 4), range(5, 7)]
     >>> all(isinstance(i, np.ndarray) for i in vectors_to_arrays(data))
     True
-
     """
     arrays = [as_c_contiguous(np.asarray(i)) for i in vectors]
     return arrays
@@ -201,7 +197,6 @@ def as_c_contiguous(array):
     True
     >>> as_c_contiguous(x).flags.c_contiguous
     True
-
     """
     if not array.flags.c_contiguous:
         return array.copy(order="C")
@@ -239,7 +234,6 @@ def kwargs_to_ctypes_array(argument, kwargs, dtype):
     ... )
     >>> print(should_be_none)
     None
-
     """
     if argument in kwargs:
         return dtype(*kwargs[argument])

pygmt/clib/loading.py

@@ -30,7 +30,6 @@ def load_libgmt():
     GMTCLibNotFoundError
         If there was any problem loading the library (couldn't find it or
         couldn't access the functions).
-
     """
     lib_fullnames = clib_full_names()
     error = True
@@ -64,7 +63,6 @@ def clib_names(os_name):
     -------
     libnames : list of str
         List of possible names of GMT's shared library.
-
     """
     if os_name.startswith("linux"):
         libnames = ["libgmt.so"]
@@ -93,7 +91,6 @@ def clib_full_names(env=None):
     -------
     lib_fullnames: list of str
         List of possible full names of GMT's shared library.
-
     """
     if env is None:
         env = os.environ
@@ -127,7 +124,6 @@ def check_libgmt(libgmt):
     Raises
     ------
     GMTCLibError
-
     """
     # Check if a few of the functions we need are in the library
     functions = ["Create_Session", "Get_Enum", "Call_Module", "Destroy_Session"]