Use consistent docstrings for test files (#2578)

Co-authored-by: Max Jones <[email protected]>
Co-authored-by: Yvonne Fröhlich <[email protected]>

Author: 3 people

pygmt/tests/test_basemap.py

@@ -1,5 +1,5 @@
 """
-Tests Figure.basemap.
+Test Figure.basemap.
 """
 import pytest
 from pygmt import Figure

pygmt/tests/test_binstats.py

@@ -1,5 +1,5 @@
 """
-Tests for binstats.
+Test pygmt.binstats.
 """
 from pathlib import Path
 

pygmt/tests/test_blockm.py

@@ -1,5 +1,5 @@
 """
-Tests for blockmean and blockmode.
+Test pygmt.blockmean and pygmt.blockmode.
 """
 from pathlib import Path
 

pygmt/tests/test_blockmedian.py

@@ -1,5 +1,5 @@
 """
-Tests for blockmedian.
+Test pygmt.blockmedian.
 """
 from pathlib import Path
 

pygmt/tests/test_clib_loading.py

@@ -57,7 +57,7 @@ def test_clib_names():
 
 
 ###############################################################################
-# Tests for load_libgmt
+# Test load_libgmt
 def test_load_libgmt():
     """
     Test that loading libgmt works and doesn't crash.
@@ -208,7 +208,7 @@ def test_brokenlib_brokenlib_workinglib(
 
 
 ###############################################################################
-# Tests for clib_full_names
+# Test clib_full_names
 @pytest.fixture(scope="module", name="gmt_lib_names")
 def fixture_gmt_lib_names():
     """

pygmt/tests/test_coast.py

@@ -1,5 +1,5 @@
 """
-Tests for fig.coast.
+Test Figure.coast.
 """
 import pytest
 from pygmt import Figure

pygmt/tests/test_colorbar.py

@@ -1,5 +1,5 @@
 """
-Tests colorbar.
+Test Figure.colorbar.
 """
 import pytest
 from pygmt import Figure

pygmt/tests/test_config.py

@@ -1,5 +1,5 @@
 """
-Tests for pygmt.config.
+Test pygmt.config.
 """
 import pytest
 from pygmt import Figure, config

pygmt/tests/test_contour.py

@@ -1,6 +1,6 @@
 # pylint: disable=redefined-outer-name
 """
-Tests contour.
+Test Figure.contour.
 """
 import os
 

pygmt/tests/test_dimfilter.py

@@ -1,5 +1,5 @@
 """
-Tests for dimfilter.
+Test pygmt.dimfilter.
 """
 from pathlib import Path
 

pygmt/tests/test_filter1d.py

@@ -1,5 +1,5 @@
 """
-Tests for filter1d.
+Test pygmt.filter1d.
 """
 from pathlib import Path
 

pygmt/tests/test_geopandas.py

@@ -1,5 +1,5 @@
 """
-Tests on integration with geopandas.
+Test integration with geopandas.
 """
 import numpy.testing as npt
 import pytest

pygmt/tests/test_grd2cpt.py

@@ -1,5 +1,5 @@
 """
-Tests for grd2cpt.
+Test pygmt.grd2cpt.
 """
 import os
 

pygmt/tests/test_grd2xyz.py

@@ -1,5 +1,5 @@
 """
-Tests for grd2xyz.
+Test pygmt.grd2xyz.
 """
 from pathlib import Path
 

pygmt/tests/test_grdclip.py

@@ -1,5 +1,5 @@
 """
-Tests for grdclip.
+Test pygmt.grdclip.
 """
 from pathlib import Path
 

pygmt/tests/test_grdcut.py

@@ -1,5 +1,5 @@
 """
-Tests for grdcut.
+Test pygmt.grdcut.
 """
 import numpy as np
 import pytest

pygmt/tests/test_grdfill.py

@@ -1,5 +1,5 @@
 """
-Tests for grdfill.
+Test pygmt.grdfill.
 """
 from pathlib import Path
 

pygmt/tests/test_grdfilter.py

@@ -1,5 +1,5 @@
 """
-Tests for grdfilter.
+Test pygmt.grdfilter.
 """
 from pathlib import Path
 

pygmt/tests/test_grdgradient.py

@@ -1,5 +1,5 @@
 """
-Tests for grdgradient.
+Test pygmt.grdgradient.
 """
 from pathlib import Path
 

pygmt/tests/test_grdhisteq.py

@@ -1,5 +1,5 @@
 """
-Tests for grdhisteq.
+Test pygmt.grdhisteq.
 """
 from pathlib import Path
 

pygmt/tests/test_grdinfo.py

@@ -1,5 +1,5 @@
 """
-Tests for grdinfo.
+Test pygmt.grdinfo.
 """
 import numpy as np
 import pytest

pygmt/tests/test_grdlandmask.py

@@ -1,5 +1,5 @@
 """
-Tests for grdlandmask.
+Test pygmt.grdlandmask.
 """
 from pathlib import Path
 

pygmt/tests/test_grdproject.py

@@ -1,5 +1,5 @@
 """
-Tests for grdproject.
+Test pygmt.grdproject.
 """
 from pathlib import Path
 

pygmt/tests/test_grdsample.py

@@ -1,5 +1,5 @@
 """
-Tests for grdsample.
+Test pygmt.grdsample.
 """
 from pathlib import Path
 

pygmt/tests/test_grdtrack.py

@@ -1,5 +1,5 @@
 """
-Tests for grdtrack.
+Test pygmt.grdtrack.
 """
 import os
 from pathlib import Path

pygmt/tests/test_grdview.py

@@ -1,5 +1,5 @@
 """
-Tests grdview.
+Test Figure.grdview.
 """
 import pytest
 from pygmt import Figure, grdcut

pygmt/tests/test_grdvolume.py

@@ -1,5 +1,5 @@
 """
-Tests for grdvolume.
+Test pygmt.grdvolume.
 """
 from pathlib import Path
 

pygmt/tests/test_helpers.py

@@ -1,5 +1,5 @@
 """
-Tests the helper functions/classes/etc used in wrapping GMT.
+Test the helper functions/classes/etc used in wrapping GMT.
 """
 import os
 

pygmt/tests/test_histogram.py

@@ -1,6 +1,6 @@
 # pylint: disable=redefined-outer-name
 """
-Tests histogram.
+Test Figure.histogram.
 """
 import pandas as pd
 import pytest
@@ -10,7 +10,7 @@
 @pytest.fixture(scope="module", name="data", params=[list, pd.Series])
 def fixture_data(request):
     """
-    Returns a list of integers to be used in the histogram.
+    Return a list of integers to be used in the histogram.
     """
     data = [1, 1, 1, 1, 1, 1, 2, 2, 2, 3, 4, 5, 6, 7, 8, 8, 8, 8, 8, 8]
     return request.param(data)
@@ -19,7 +19,7 @@ def fixture_data(request):
 @pytest.mark.mpl_image_compare(filename="test_histogram.png")
 def test_histogram(data):
     """
-    Tests plotting a histogram using a sequence of integers from a table.
+    Test plotting a histogram using a sequence of integers from a table.
     """
     fig = Figure()
     fig.histogram(

pygmt/tests/test_image.py

@@ -1,5 +1,5 @@
 """
-Tests image.
+Test Figure.image.
 """
 import os
 import sys

pygmt/tests/test_info.py

@@ -1,5 +1,5 @@
 """
-Tests for gmtinfo.
+Test pygmt.info.
 """
 import os
 import pathlib

pygmt/tests/test_inset.py

@@ -1,5 +1,5 @@
 """
-Tests for the inset function.
+Test Figure.inset.
 """
 import pytest
 from pygmt import Figure

pygmt/tests/test_io.py

@@ -1,5 +1,5 @@
 """
-Tests for input/output (I/O) utilities.
+Test input/output (I/O) utilities.
 """
 import numpy as np
 import pytest

pygmt/tests/test_legend.py

@@ -1,5 +1,5 @@
 """
-Tests for legend.
+Test Figure.legend.
 """
 import pytest
 from pygmt import Figure

pygmt/tests/test_logo.py

@@ -1,5 +1,5 @@
 """
-Tests for fig.logo.
+Test Figure.logo.
 """
 import pytest
 from pygmt import Figure

pygmt/tests/test_makecpt.py

@@ -1,5 +1,5 @@
 """
-Tests for makecpt.
+Test pygmt.makecpt.
 """
 import os
 from pathlib import Path

pygmt/tests/test_meca.py

@@ -1,5 +1,5 @@
 """
-Tests for meca.
+Test Figure.meca.
 """
 import numpy as np
 import pandas as pd

pygmt/tests/test_nearneighbor.py

@@ -1,5 +1,5 @@
 """
-Tests for nearneighbor.
+Test pygmt.nearneighbor.
 """
 from pathlib import Path
 

pygmt/tests/test_plot.py

@@ -1,6 +1,6 @@
 # pylint: disable=redefined-outer-name
 """
-Tests plot.
+Test Figure.plot.
 """
 import datetime
 import os

pygmt/tests/test_plot3d.py

@@ -1,5 +1,5 @@
 """
-Tests plot3d.
+Test Figure.plot3d.
 """
 import os
 from pathlib import Path

pygmt/tests/test_project.py

@@ -1,5 +1,5 @@
 """
-Tests for project.
+Test pygmt.project.
 """
 from pathlib import Path
 

pygmt/tests/test_psconvert.py

@@ -1,5 +1,5 @@
 """
-Tests psconvert.
+Test Figure.psconvert.
 """
 import os
 

pygmt/tests/test_rose.py

@@ -1,5 +1,5 @@
 """
-Tests for rose.
+Test Figure.rose.
 """
 import numpy as np
 import pytest

pygmt/tests/test_select.py

@@ -1,5 +1,5 @@
 """
-Tests for select.
+Test pygmt.select.
 """
 from pathlib import Path
 

pygmt/tests/test_solar.py

@@ -1,5 +1,5 @@
 """
-Tests for solar.
+Test Figure.solar.
 """
 import datetime
 

pygmt/tests/test_sph2grd.py

@@ -1,5 +1,5 @@
 """
-Tests for sph2grd.
+Test pygmt.sph2grd.
 """
 from pathlib import Path
 

pygmt/tests/test_sphdistance.py

@@ -1,5 +1,5 @@
 """
-Tests for sphdistance.
+Test pygmt.sphdistance.
 """
 from pathlib import Path
 

pygmt/tests/test_sphinterpolate.py

@@ -1,5 +1,5 @@
 """
-Tests for sphinterpolate.
+Test pygmt.sphinterpolate.
 """
 from pathlib import Path
 

pygmt/tests/test_subplot.py

@@ -1,5 +1,5 @@
 """
-Tests subplot.
+Test Figure.subplot.
 """
 import pytest
 from pygmt import Figure

pygmt/tests/test_surface.py

@@ -1,5 +1,5 @@
 """
-Tests for surface.
+Test pygmt.surface.
 """
 from pathlib import Path
 

pygmt/tests/test_ternary.py

@@ -1,5 +1,5 @@
 """
-Tests ternary.
+Test Figure.ternary.
 """
 import numpy as np
 import pytest

pygmt/tests/test_text.py

@@ -1,5 +1,5 @@
 """
-Tests text.
+Test Figure.text.
 """
 import os