DOC: Fix GL01 and GL02 errors in the docstrings

pandas/conftest.py

@@ -123,18 +123,22 @@ def ip():
 
 @pytest.fixture(params=[True, False, None])
 def observed(request):
-    """ pass in the observed keyword to groupby for [True, False]
+    """
+    pass in the observed keyword to groupby for [True, False]
     This indicates whether categoricals should return values for
     values which are not in the grouper [False / None], or only values which
     appear in the grouper [True]. [None] is supported for future compatibility
     if we decide to change the default (and would need to warn if this
-    parameter is not passed)"""
+    parameter is not passed)
+    """
     return request.param
 
 
 @pytest.fixture(params=[True, False, None])
 def ordered_fixture(request):
-    """Boolean 'ordered' parameter for Categorical."""
+    """
+    Boolean 'ordered' parameter for Categorical.
+    """
     return request.param
 
 
@@ -234,7 +238,8 @@ def cython_table_items(request):
 
 
 def _get_cython_table_params(ndframe, func_names_and_expected):
-    """combine frame, functions from SelectionMixin._cython_table
+    """
+    combine frame, functions from SelectionMixin._cython_table
     keys and expected result.
 
     Parameters
@@ -341,7 +346,8 @@ def strict_data_files(pytestconfig):
 
 @pytest.fixture
 def datapath(strict_data_files):
-    """Get the path to a data file.
+    """
+    Get the path to a data file.
 
     Parameters
     ----------
@@ -375,7 +381,9 @@ def deco(*args):
 
 @pytest.fixture
 def iris(datapath):
-    """The iris dataset as a DataFrame."""
+    """
+    The iris dataset as a DataFrame.
+    """
     return pd.read_csv(datapath("data", "iris.csv"))
 
 
@@ -504,7 +512,8 @@ def tz_aware_fixture(request):
 
 @pytest.fixture(params=STRING_DTYPES)
 def string_dtype(request):
-    """Parametrized fixture for string dtypes.
+    """
+    Parametrized fixture for string dtypes.
 
     * str
     * 'str'
@@ -515,7 +524,8 @@ def string_dtype(request):
 
 @pytest.fixture(params=BYTES_DTYPES)
 def bytes_dtype(request):
-    """Parametrized fixture for bytes dtypes.
+    """
+    Parametrized fixture for bytes dtypes.
 
     * bytes
     * 'bytes'
@@ -525,7 +535,8 @@ def bytes_dtype(request):
 
 @pytest.fixture(params=OBJECT_DTYPES)
 def object_dtype(request):
-    """Parametrized fixture for object dtypes.
+    """
+    Parametrized fixture for object dtypes.
 
     * object
     * 'object'
@@ -535,7 +546,8 @@ def object_dtype(request):
 
 @pytest.fixture(params=DATETIME64_DTYPES)
 def datetime64_dtype(request):
-    """Parametrized fixture for datetime64 dtypes.
+    """
+    Parametrized fixture for datetime64 dtypes.
 
     * 'datetime64[ns]'
     * 'M8[ns]'
@@ -545,7 +557,8 @@ def datetime64_dtype(request):
 
 @pytest.fixture(params=TIMEDELTA64_DTYPES)
 def timedelta64_dtype(request):
-    """Parametrized fixture for timedelta64 dtypes.
+    """
+    Parametrized fixture for timedelta64 dtypes.
 
     * 'timedelta64[ns]'
     * 'm8[ns]'

pandas/io/html.py

@@ -1,4 +1,5 @@
-""":mod:`pandas.io.html` is a module containing functionality for dealing with
+"""
+:mod:`pandas.io.html` is a module containing functionality for dealing with
 HTML IO.
 
 """
@@ -58,7 +59,8 @@ def _importers():
 
 
 def _remove_whitespace(s, regex=_RE_WHITESPACE):
-    """Replace extra whitespace inside of a string with a single space.
+    """
+    Replace extra whitespace inside of a string with a single space.
 
     Parameters
     ----------
@@ -77,7 +79,8 @@ def _remove_whitespace(s, regex=_RE_WHITESPACE):
 
 
 def _get_skiprows(skiprows):
-    """Get an iterator given an integer, slice or container.
+    """
+    Get an iterator given an integer, slice or container.
 
     Parameters
     ----------
@@ -107,7 +110,8 @@ def _get_skiprows(skiprows):
 
 
 def _read(obj):
-    """Try to read from a url, file or string.
+    """
+    Try to read from a url, file or string.
 
     Parameters
     ----------
@@ -136,7 +140,8 @@ def _read(obj):
 
 
 class _HtmlFrameParser:
-    """Base class for parsers that parse HTML into DataFrames.
+    """
+    Base class for parsers that parse HTML into DataFrames.
 
     Parameters
     ----------
@@ -515,7 +520,8 @@ def _handle_hidden_tables(self, tbl_list, attr_name):
 
 
 class _BeautifulSoupHtml5LibFrameParser(_HtmlFrameParser):
-    """HTML to DataFrame parser that uses BeautifulSoup under the hood.
+    """
+    HTML to DataFrame parser that uses BeautifulSoup under the hood.
 
     See Also
     --------
@@ -622,7 +628,8 @@ def _build_xpath_expr(attrs):
 
 
 class _LxmlFrameParser(_HtmlFrameParser):
-    """HTML to DataFrame parser that uses lxml under the hood.
+    """
+    HTML to DataFrame parser that uses lxml under the hood.
 
     Warning
     -------
@@ -937,7 +944,8 @@ def read_html(
     keep_default_na=True,
     displayed_only=True,
 ):
-    r"""Read HTML tables into a ``list`` of ``DataFrame`` objects.
+    r"""
+    Read HTML tables into a ``list`` of ``DataFrame`` objects.
 
     Parameters
     ----------

pandas/plotting/_matplotlib/hist.py

@@ -84,7 +84,9 @@ def _make_plot(self):
             self._add_legend_handle(artists[0], label, index=i)
 
     def _make_plot_keywords(self, kwds, y):
-        """merge BoxPlot/KdePlot properties to passed kwds"""
+        """
+        Merge BoxPlot/KdePlot properties to passed kwds.
+        """
         # y is required for KdePlot
         kwds["bottom"] = self.bottom
         kwds["bins"] = self.bins

pandas/plotting/_matplotlib/style.py

@@ -43,7 +43,9 @@ def _get_standard_colors(
         elif color_type == "random":
 
             def random_color(column):
-                """ Returns a random color represented as a list of length 3"""
+                """
+                Returns a random color represented as a list of length 3.
+                """
                 # GH17525 use common._random_state to avoid resetting the seed
                 rs = com.random_state(column)
                 return rs.rand(3).tolist()

pandas/plotting/_matplotlib/timeseries.py

@@ -169,7 +169,9 @@ def _replot_ax(ax, freq, kwargs):
 
 
 def _decorate_axes(ax, freq, kwargs):
-    """Initialize axes for time-series plotting"""
+    """
+    Initialize axes for time-series plotting.
+    """
     if not hasattr(ax, "_plot_data"):
         ax._plot_data = []
 

pandas/plotting/_matplotlib/tools.py

@@ -106,7 +106,8 @@ def _subplots(
     layout_type="box",
     **fig_kw
 ):
-    """Create a figure with a set of subplots already made.
+    """
+    Create a figure with a set of subplots already made.
 
     This utility wrapper makes it convenient to create common layouts of
     subplots, including the enclosing figure object, in a single call.

pandas/plotting/_misc.py

@@ -329,7 +329,8 @@ def parallel_coordinates(
     sort_labels=False,
     **kwds
 ):
-    """Parallel coordinates plotting.
+    """
+    Parallel coordinates plotting.
 
     Parameters
     ----------
@@ -392,7 +393,8 @@ def parallel_coordinates(
 
 
 def lag_plot(series, lag=1, ax=None, **kwds):
-    """Lag plot for time series.
+    """
+    Lag plot for time series.
 
     Parameters
     ----------

pandas/tests/io/conftest.py

@@ -9,25 +9,32 @@
 
 @pytest.fixture
 def tips_file(datapath):
-    """Path to the tips dataset"""
+    """
+    Path to the tips dataset.
+    """
     return datapath("io", "parser", "data", "tips.csv")
 
 
 @pytest.fixture
 def jsonl_file(datapath):
-    """Path a JSONL dataset"""
+    """
+    Path a JSONL dataset.
+    """
     return datapath("io", "parser", "data", "items.jsonl")
 
 
 @pytest.fixture
 def salaries_table(datapath):
-    """DataFrame with the salaries dataset"""
+    """
+    DataFrame with the salaries dataset.
+    """
     return read_csv(datapath("io", "parser", "data", "salaries.csv"), sep="\t")
 
 
 @pytest.fixture
 def s3_resource(tips_file, jsonl_file):
-    """Fixture for mocking S3 interaction.
+    """
+    Fixture for mocking S3 interaction.
 
     The primary bucket name is "pandas-test". The following datasets
     are loaded.

pandas/tests/io/generate_legacy_storage_files.py

@@ -131,7 +131,9 @@ def _create_sp_frame():
 
 
 def create_data():
-    """ create the pickle/msgpack data """
+    """
+    Create the pickle/msgpack data.
+    """
 
     data = {
         "A": [0.0, 1.0, 2.0, 3.0, np.nan],

pandas/tests/io/msgpack/test_read_size.py

@@ -1,4 +1,6 @@
-"""Test Unpacker's read_array_header and read_map_header methods"""
+"""
+Test Unpacker's read_array_header and read_map_header methods.
+"""
 from pandas.io.msgpack import OutOfData, Unpacker, packb
 
 UnexpectedTypeException = ValueError

pandas/tests/io/msgpack/test_unpack_raw.py

@@ -1,4 +1,6 @@
-"""Tests for cases where the user seeks to obtain packed msgpack objects"""
+"""
+Tests for cases where the user seeks to obtain packed msgpack objects.
+"""
 
 import io
 

pandas/tests/io/test_clipboard.py

@@ -111,7 +111,8 @@ def df(request):
 
 @pytest.fixture
 def mock_clipboard(monkeypatch, request):
-    """Fixture mocking clipboard IO.
+    """
+    Fixture mocking clipboard IO.
 
     This mocks pandas.io.clipboard.clipboard_get and
     pandas.io.clipboard.clipboard_set.

pandas/tests/io/test_common.py

@@ -17,7 +17,9 @@
 
 
 class CustomFSPath:
-    """For testing fspath on unknown objects"""
+    """
+    For testing fspath on unknown objects.
+    """
 
     def __init__(self, path):
         self.path = path

pandas/tests/io/test_html.py

@@ -33,7 +33,9 @@
     ]
 )
 def html_encoding_file(request, datapath):
-    """Parametrized fixture for HTML encoding test filenames."""
+    """
+    Parametrized fixture for HTML encoding test filenames.
+    """
     return datapath("io", "data", "html_encoding", request.param)
 
 

pandas/tests/io/test_stata.py

@@ -1769,10 +1769,11 @@ def test_strl_latin1(self):
     def test_encoding_latin1_118(self):
         # GH 25960
         msg = """
-One or more strings in the dta file could not be decoded using utf-8, and
-so the fallback encoding of latin-1 is being used.  This can happen when a file
-has been incorrectly encoded by Stata or some other software. You should verify
-the string values returned are correct."""
+            One or more strings in the dta file could not be decoded using utf-8, and
+            so the fallback encoding of latin-1 is being used.  This can happen when a file
+            has been incorrectly encoded by Stata or some other software. You should verify
+            the string values returned are correct.
+        """
         with tm.assert_produces_warning(UnicodeWarning) as w:
             encoded = read_stata(self.dta_encoding_118)
             assert len(w) == 151

pandas/tests/scalar/timedelta/test_timedelta.py

@@ -1,4 +1,6 @@
-""" test the scalar Timedelta """
+"""
+Test the scalar Timedelta.
+"""
 from datetime import timedelta
 import re
 

pandas/tests/test_base.py

@@ -112,7 +112,9 @@ def _get_foo(self):
         foo = property(_get_foo, _set_foo, doc="foo property")
 
         def bar(self, *args, **kwargs):
-            """ a test bar method """
+            """
+            A test bar method.
+            """
             pass
 
     class Delegate(PandasDelegate, PandasObject):
@@ -158,7 +160,9 @@ def test_memory_usage(self):
 
 class Ops:
     def _allow_na_ops(self, obj):
-        """Whether to skip test cases including NaN"""
+        """
+        Whether to skip test cases including NaN.
+        """
         if isinstance(obj, Index) and (obj.is_boolean() or not obj._can_hold_na):
             # don't test boolean / int64 index
             return False

pandas/tests/test_expressions.py

@@ -102,7 +102,7 @@ def run_binary(
         numexpr_ops={"gt", "lt", "ge", "le", "eq", "ne"},
     ):
         """
-        tests solely that the result is the same whether or not numexpr is
+        Tests solely that the result is the same whether or not numexpr is
         enabled.  Need to test whether the function does the correct thing
         elsewhere.
         """