fix(docs): section underline matches section title (#2208)

This PR fixes the doc section headers to have consistent lengths. It is a cause of many errors while building docs with sphinx.

This was mostly automated with ruff check --select=D409 --fix with the rule kept in pyproject.toml for future-proofing.

flopy/discretization/grid.py

@@ -128,7 +128,7 @@ class Grid:
         ndarrays for the x, y, and z coordinates
 
     Methods
-    ----------
+    -------
     get_coords(x, y)
         transform point or array of points x, y from model coordinates to
         spatial coordinates

flopy/discretization/structuredgrid.py

@@ -140,7 +140,7 @@ class for a structured model grid
         y-location points for the edges of the model grid
 
     Methods
-    ----------
+    -------
     get_cell_vertices(i, j)
         returns vertices for a single cell at row, column i, j.
     """

flopy/discretization/vertexgrid.py

@@ -61,7 +61,7 @@ class for a vertex model grid
         returns list of cells and their vertices
 
     Methods
-    ----------
+    -------
     get_cell_vertices(cellid)
         returns vertices for a single cell at cellid.
 

flopy/export/netcdf.py

@@ -976,7 +976,7 @@ def initialize_group(
         Method to initialize a new group within a netcdf file. This group
         can have independent dimensions from the global dimensions
 
-        Parameters:
+        Parameters
         ----------
         name : str
             name of the netcdf group

flopy/export/utils.py

@@ -324,10 +324,11 @@ def output_helper(
 
     Returns
     -------
-        None
-    Note:
+    None
+
+    Note
     ----
-        casts down double precision to single precision for netCDF files
+    casts down double precision to single precision for netCDF files
 
     """
     assert isinstance(ml, (BaseModel, ModelInterface))
@@ -867,7 +868,7 @@ def mflist_export(f: Union[str, os.PathLike, NetCdf], mfl, **kwargs):
     export helper for MfList instances
 
     Parameters
-    -----------
+    ----------
     f : str or PathLike or NetCdf
         file path or existing export instance type (NetCdf only for now)
     mfl : MfList instance
@@ -1024,7 +1025,7 @@ def transient2d_export(f: Union[str, os.PathLike], t2d, fmt=None, **kwargs):
     export helper for Transient2d instances
 
     Parameters
-    -----------
+    ----------
     f : str or PathLike
         filename or existing export instance type (NetCdf only for now)
     t2d : Transient2d instance
@@ -1184,7 +1185,7 @@ def array3d_export(f: Union[str, os.PathLike], u3d, fmt=None, **kwargs):
     export helper for Transient2d instances
 
     Parameters
-    -----------
+    ----------
     f : str or PathLike
         filename or existing export instance type (NetCdf only for now)
     u3d : Util3d instance

flopy/mbase.py

@@ -1678,7 +1678,7 @@ def plot(self, SelPackList=None, **kwargs):
                 MfList dictionary key. (default is None)
 
         Returns
-        ----------
+        -------
         axes : list
             Empty list is returned if filename_base is not None. Otherwise
             a list of matplotlib.pyplot.axis are returned.

flopy/mf6/coordinates/modeldimensions.py

@@ -28,7 +28,7 @@ class DataDimensions:
         (optional)
 
     Methods
-    ----------
+    -------
     get_model_grid : ()
         returns a model grid based on the current simulation data
 
@@ -151,7 +151,7 @@ class PackageDimensions:
         Tuple representing the path to this package
 
     Methods
-    ----------
+    -------
     get_aux_variables : (model_num=0)
         returns the package's aux variables
     boundnames : (model_num=0)
@@ -322,7 +322,7 @@ class ModelDimensions:
         object containing simulation time information
 
     Methods
-    ----------
+    -------
     get_model_grid : ()
         returns a model grid based on the current simulation data
 

flopy/mf6/coordinates/modelgrid.py

@@ -20,7 +20,7 @@ class ModelCell:
         id of model cell
 
     Methods
-    ----------
+    -------
 
     See Also
     --------
@@ -50,7 +50,7 @@ class UnstructuredModelCell(ModelCell):
         name of the model
 
     Methods
-    ----------
+    -------
     get_cellid : ()
         returns the cellid
     get_top : ()
@@ -341,7 +341,7 @@ class ModelGrid:
         DiscretizationType.DISU)
 
     Methods
-    ----------
+    -------
     grid_type : ()
         returns the grid type
     grid_type_consistent : ()
@@ -789,7 +789,7 @@ class UnstructuredModelGrid(ModelGrid):
         contains all simulation related data
 
     Methods
-    ----------
+    -------
     get_unstruct_jagged_array_list : {}
         returns a dictionary of jagged arrays used in the unstructured grid
 

flopy/mf6/data/mfdataarray.py

@@ -1531,7 +1531,7 @@ def plot(
                 List of unique values to be excluded from the plot.
 
         Returns
-        ----------
+        -------
         out : list
             Empty list is returned if filename_base is not None. Otherwise
             a list of matplotlib.pyplot.axis is returned.
@@ -2100,7 +2100,7 @@ def plot(
                 extracted. (default is zero).
 
         Returns
-        ----------
+        -------
         axes : list
             Empty list is returned if filename_base is not None. Otherwise
             a list of matplotlib.pyplot.axis is returned.

flopy/mf6/data/mfdatalist.py

@@ -136,7 +136,7 @@ def to_array(self, kper=0, mask=False):
             return array with np.nan instead of zero
 
         Returns
-        ----------
+        -------
         out : dict of numpy.ndarrays
             Dictionary of 3-D numpy arrays containing the stress period data
             for a selected stress period. The dictionary keys are the
@@ -1451,7 +1451,7 @@ def plot(
                 List of unique values to be excluded from the plot.
 
         Returns
-        ----------
+        -------
         out : list
             Empty list is returned if filename_base is not None. Otherwise
             a list of matplotlib.pyplot.axis is returned.
@@ -2122,7 +2122,7 @@ def plot(
                 List of unique values to be excluded from the plot.
 
         Returns
-        ----------
+        -------
         out : list
             Empty list is returned if filename_base is not None. Otherwise
             a list of matplotlib.pyplot.axis is returned.

flopy/mf6/data/mfdataplist.py

@@ -815,7 +815,7 @@ def to_array(self, kper=0, mask=False):
             return array with np.nan instead of zero
 
         Returns
-        ----------
+        -------
         out : dict of numpy.ndarrays
             Dictionary of 3-D numpy arrays containing the stress period data
             for a selected stress period. The dictionary keys are the
@@ -1882,7 +1882,7 @@ def plot(
                 List of unique values to be excluded from the plot.
 
         Returns
-        ----------
+        -------
         out : list
             Empty list is returned if filename_base is not None. Otherwise
             a list of matplotlib.pyplot.axis is returned.
@@ -2604,7 +2604,7 @@ def plot(
                 List of unique values to be excluded from the plot.
 
         Returns
-        ----------
+        -------
         out : list
             Empty list is returned if filename_base is not None. Otherwise
             a list of matplotlib.pyplot.axis is returned.

flopy/mf6/data/mfdatascalar.py

@@ -668,7 +668,8 @@ def plot(self, filename_base=None, file_extension=None, **kwargs):
         """
         Helper method to plot scalar objects
 
-        Parameters:
+        Parameters
+        ----------
             scalar : flopy.mf6.data.mfscalar object
             filename_base : str
                 Base file name that will be used to automatically generate file
@@ -976,7 +977,7 @@ def plot(
                 extracted. (default is zero).
 
         Returns
-        ----------
+        -------
         axes : list
             Empty list is returned if filename_base is not None. Otherwise
             a list of matplotlib.pyplot.axis is returned.

flopy/mf6/data/mfdatautil.py

@@ -155,7 +155,7 @@ def list_to_array(sarr, model_grid, kper=0, mask=False):
         return array with np.nan instead of zero
 
     Returns
-    ----------
+    -------
     out : dict of numpy.ndarrays
         Dictionary of 3-D numpy arrays containing the stress period data
         for a selected stress period. The dictionary keys are the

flopy/mf6/data/mfstructure.py

@@ -63,7 +63,7 @@ class Dfn:
     -----
 
     Examples
-    ----
+    --------
     """
 
     def __init__(self):
@@ -179,7 +179,7 @@ class DfnPackage(Dfn):
     -----
 
     Examples
-    ----
+    --------
     """
 
     def __init__(self, package):
@@ -447,7 +447,7 @@ class DfnFile(Dfn):
     -----
 
     Examples
-    ----
+    --------
     """
 
     def __init__(self, file):

flopy/mf6/mfpackage.py

@@ -3279,7 +3279,7 @@ def plot(self, **kwargs):
                 MfList dictionary key. (default is None)
 
         Returns
-        ----------
+        -------
         axes : list
             Empty list is returned if filename_base is not None. Otherwise
             a list of matplotlib.pyplot.axis are returned.