Rewrap docstrings to 88 characters (#2926)

Author: seisman

pygmt/__init__.py

@@ -1,10 +1,10 @@
 """
 PyGMT is a library for processing geospatial and geophysical data and making
-publication-quality maps and figures. It provides a Pythonic interface for the
-Generic Mapping Tools (GMT), a command-line program widely used across the
-Earth, Ocean, and Planetary sciences and beyond. Besides making GMT more
-accessible to new users, PyGMT aims to provide integration with the PyData
-ecosystem as well as support for rich display in Jupyter notebooks.
+publication-quality maps and figures. It provides a Pythonic interface for the Generic
+Mapping Tools (GMT), a command-line program widely used across the Earth, Ocean, and
+Planetary sciences and beyond. Besides making GMT more accessible to new users, PyGMT
+aims to provide integration with the PyData ecosystem as well as support for rich
+display in Jupyter notebooks.
 
 Main Features
 -------------
@@ -93,8 +93,7 @@ def print_clib_info(file=sys.stdout):
 
 def show_versions(file=sys.stdout):
     """
-    Print various dependency versions which are useful when submitting bug
-    reports.
+    Print various dependency versions which are useful when submitting bug reports.
 
     This includes information about:
 

pygmt/accessors.py

@@ -150,8 +150,7 @@ def registration(self, value):
     @property
     def gtype(self):
         """
-        Coordinate system type of the grid, either 0 (Cartesian) or 1
-        (Geographic).
+        Coordinate system type of the grid, either 0 (Cartesian) or 1 (Geographic).
         """
         return self._gtype
 

pygmt/clib/__init__.py

@@ -1,8 +1,8 @@
 """
 Low-level wrapper for the GMT C API.
 
-The pygmt.clib.Session class wraps the GMT C shared library (libgmt) with a
-Pythonic interface. Access to the C library is done through ctypes.
+The pygmt.clib.Session class wraps the GMT C shared library (libgmt) with a Pythonic
+interface. Access to the C library is done through ctypes.
 """
 
 from pygmt.clib.session import Session

pygmt/clib/conversion.py

@@ -126,8 +126,7 @@ def dataarray_to_matrix(grid):
 
 def vectors_to_arrays(vectors):
     """
-    Convert 1-D vectors (lists, arrays, or pandas.Series) to C contiguous 1-D
-    arrays.
+    Convert 1-D vectors (lists, arrays, or pandas.Series) to C contiguous 1-D arrays.
 
     Arrays must be in C contiguous order for us to pass their memory pointers
     to GMT. If any are not, convert them to C order (which requires copying the

pygmt/clib/loading.py

@@ -1,8 +1,8 @@
 """
 Utility functions to load libgmt as ctypes.CDLL.
 
-The path to the shared library can be found automatically by ctypes or set
-through the GMT_LIBRARY_PATH environment variable.
+The path to the shared library can be found automatically by ctypes or set through the
+GMT_LIBRARY_PATH environment variable.
 """
 import ctypes
 import os

pygmt/clib/session.py

@@ -1,6 +1,6 @@
 """
-Defines the Session class to create and destroy a GMT API session and provides
-access to the API functions.
+Defines the Session class to create and destroy a GMT API session and provides access to
+the API functions.
 
 Uses ctypes to wrap most of the core functions from the C API.
 """
@@ -369,11 +369,11 @@ def create(self, name):
         @ctp.CFUNCTYPE(ctp.c_int, ctp.c_void_p, ctp.c_char_p)
         def print_func(file_pointer, message):  # noqa: ARG001
             """
-            Callback function that the GMT C API will use to print log and
-            error messages.
+            Callback function that the GMT C API will use to print log and error
+            messages.
 
-            We'll capture the messages and print them to stderr so that they
-            will show up on the Jupyter notebook.
+            We'll capture the messages and print them to stderr so that they will show
+            up on the Jupyter notebook.
             """
             message = message.decode().strip()
             self._error_log.append(message)
@@ -497,8 +497,8 @@ def get_default(self, name):
 
     def get_common(self, option):
         """
-        Inquire if a GMT common option has been set and return its current
-        value if possible.
+        Inquire if a GMT common option has been set and return its current value if
+        possible.
 
         Parameters
         ----------
@@ -720,9 +720,9 @@ def _parse_pad(self, family, kwargs):
         """
         Parse and return an appropriate value for pad if none is given.
 
-        Pad is a bit tricky because, for matrix types, pad control the matrix
-        ordering (row or column major). Using the default pad will set it to
-        column major and mess things up with the numpy arrays.
+        Pad is a bit tricky because, for matrix types, pad control the matrix ordering
+        (row or column major). Using the default pad will set it to column major and
+        mess things up with the numpy arrays.
         """
         pad = kwargs.get("pad", None)
         if pad is None:
@@ -783,8 +783,8 @@ def _parse_constant(self, constant, valid, valid_modifiers=None):
 
     def _check_dtype_and_dim(self, array, ndim):
         """
-        Check that a numpy array has the given number of dimensions and is a
-        valid data type.
+        Check that a numpy array has the given number of dimensions and is a valid data
+        type.
 
         Parameters
         ----------

pygmt/datasets/earth_age.py

@@ -1,6 +1,6 @@
 """
-Function to download the Earth seafloor crustal age dataset from the GMT data
-server, and load as :class:`xarray.DataArray`.
+Function to download the Earth seafloor crustal age dataset from the GMT data server,
+and load as :class:`xarray.DataArray`.
 
 The grids are available in various resolutions.
 """

pygmt/datasets/earth_free_air_anomaly.py

@@ -1,6 +1,6 @@
 """
-Function to download the IGPP Earth Free-Air Anomaly dataset from the GMT data
-server, and load as :class:`xarray.DataArray`.
+Function to download the IGPP Earth Free-Air Anomaly dataset from the GMT data server,
+and load as :class:`xarray.DataArray`.
 
 The grids are available in various resolutions.
 """

pygmt/datasets/earth_geoid.py

@@ -1,6 +1,6 @@
 """
-Function to download the EGM2008 Earth Geoid dataset from the GMT data server,
-and load as :class:`xarray.DataArray`.
+Function to download the EGM2008 Earth Geoid dataset from the GMT data server, and load
+as :class:`xarray.DataArray`.
 
 The grids are available in various resolutions.
 """

pygmt/datasets/earth_magnetic_anomaly.py

@@ -1,6 +1,6 @@
 """
-Function to download the Earth magnetic anomaly datasets from the GMT data
-server, and load as :class:`xarray.DataArray`.
+Function to download the Earth magnetic anomaly datasets from the GMT data server, and
+load as :class:`xarray.DataArray`.
 
 The grids are available in various resolutions.
 """