Merge pull request #431 from QuLogic/doc-warnings

DOC: Fix several warnings during the build

Author: jGaboardi

libpysal/cg/alpha_shapes.py

@@ -649,8 +649,8 @@ def construct_bounding_circles(alpha_shape, radius):
     """Construct the bounding circles for an alpha shape, given the radius
     computed from the `alpha_shape_auto` method.
 
-    Arguments
-    ---------
+    Parameters
+    ----------
     alpha_shape : shapely.Polygon
         An alpha-hull with the input radius.
 

libpysal/cg/ops/_accessors.py

@@ -27,8 +27,8 @@ def get_attr(df, geom_col="geometry", inplace=False, attr=None):
 _doc_template = """
 Tabular accessor to grab a geometric object's {n} attribute.
 
-Arguments
----------
+Parameters
+----------
 df : pandas.DataFrame
     A pandas.Dataframe with a geometry column.
 geom_col : str

libpysal/cg/ops/_shapely.py

@@ -56,8 +56,8 @@ def _atomic_op(df, geom_col="geometry", inplace=False, _func=None, **kwargs):
 _doc_template = """
 Tabular version of pysal.contrib.shapely_ext.{n}
 
-Arguments
----------
+Parameters
+----------
 df : pandas.DataFrame
     A pandas dataframe with a geometry column.
 geom_col : str

libpysal/weights/_contW_lists.py

@@ -45,8 +45,8 @@ class ContiguityWeightsLists:
 
     def __init__(self, collection, wttype=1):
         """
-        Arguments
-        =========
+        Parameters
+        ----------
 
         collection: PySAL PolygonCollection
 

libpysal/weights/contiguity.py

@@ -232,8 +232,8 @@ def from_xarray(
         Notes
         -----
         1. Lower order contiguities are also selected.
-        2. Returned object contains `index` attribute that includes a 
-        `Pandas.MultiIndex` object from the DataArray.
+        2. Returned object contains `index` attribute that includes a
+           `Pandas.MultiIndex` object from the DataArray.
 
         See Also
         --------
@@ -462,8 +462,8 @@ def from_xarray(
         Notes
         -----
         1. Lower order contiguities are also selected.
-        2. Returned object contains `index` attribute that includes a 
-        `Pandas.MultiIndex` object from the DataArray.
+        2. Returned object contains `index` attribute that includes a
+           `Pandas.MultiIndex` object from the DataArray.
 
         See Also
         --------
@@ -533,8 +533,8 @@ def _from_dataframe(df, **kwargs):
     If the input dataframe is of any other geometry type than "Point",
     a value error is raised. 
 
-    Arguments
-    ---------
+    Parameters
+    ----------
     df          :   pandas.DataFrame
                     dataframe containing point geometries for a 
                     voronoi diagram.
@@ -564,7 +564,7 @@ def _build(polygons, criterion="rook", ids=None):
     This is a developer-facing function to construct a spatial weights object. 
 
     Parameters
-    ---------
+    ----------
     polygons    : list
                   list of pysal polygons to use to build contiguity
     criterion   : string

libpysal/weights/raster.py

@@ -74,7 +74,7 @@ def da2W(
     -----
     1. Lower order contiguities are also selected.
     2. Returned object contains `index` attribute that includes a
-    `Pandas.MultiIndex` object from the DataArray.
+       `Pandas.MultiIndex` object from the DataArray.
 
     Examples
     --------
@@ -175,7 +175,7 @@ def da2WSP(
     -----
     1. Lower order contiguities are also selected.
     2. Returned object contains `index` attribute that includes a
-    `Pandas.MultiIndex` object from the DataArray.
+       `Pandas.MultiIndex` object from the DataArray.
 
     Examples
     --------
@@ -307,7 +307,7 @@ def w2da(data, w, attrs={}, coords=None):
     Creates xarray.DataArray object from passed data aligned with W object.
 
     Parameters
-    ---------
+    ----------
     data : array/list/pd.Series
         1d array-like data with dimensionality conforming to w
     w : libpysal.weights.W
@@ -350,7 +350,7 @@ def wsp2da(data, wsp, attrs={}, coords=None):
     Creates xarray.DataArray object from passed data aligned with WSP object.
 
     Parameters
-    ---------
+    ----------
     data : array/list/pd.Series
         1d array-like data with dimensionality conforming to wsp
     wsp : libpysal.weights.WSP
@@ -393,7 +393,7 @@ def testDataArray(shape=(3, 4, 4), time=False, rand=False, missing_vals=True):
     Creates 2 or 3 dimensional test xarray.DataArray object
 
     Parameters
-    ---------
+    ----------
     shape : tuple
         Tuple containing shape of the DataArray aligned with
         following dimension = (lat, lon) or (layer, lat, lon)
@@ -515,7 +515,7 @@ def _index2da(data, index, attrs, coords):
     Creates xarray.DataArray object from passed data
 
     Parameters
-    ---------
+    ----------
     data : array/list/pd.Series
         1d array-like data with dimensionality conforming to index
     index : pd.MultiIndex

libpysal/weights/spatial_lag.py

@@ -194,8 +194,8 @@ def _resolve_ties(idx, normalized_labels, tally, neighbors, method, w):
     an attempt to break the tie, but if it fails, a random tiebreaker will be
     selected.
 
-    Arguments
-    ---------
+    Parameters
+    ----------
     idx                 : int
                           index (aligned with `normalized_labels`) of the 
                           current observation being resolved.

libpysal/weights/weights.py

@@ -182,8 +182,8 @@ def to_file(self, path="", format=None):
 
         See libpysal.io.FileIO for more information. 
 
-        Arguments
-        ---------
+        Parameters
+        ----------
         path    :   string
                     location to save the file
         format  :   string
@@ -203,8 +203,8 @@ def from_file(cls, path="", format=None):
         """
         Read a weights file into a W object. 
 
-        Arguments
-        ---------
+        Parameters
+        ----------
         path    :   string
                     location to save the file
         format  :   string