docs(discretization): replace ndarray(int/float) with 'int/float or n…

…darray' (similar to Scipy)
modflowpy · Mar 28, 2023 · 5c63b52 · 5c63b52
1 parent 23d2548
commit 5c63b52
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 17 deletions.
diff --git a/flopy/discretization/grid.py b/flopy/discretization/grid.py
@@ -35,13 +35,13 @@ class Grid:
     ----------
     grid_type : enumeration
         type of model grid ('structured', 'vertex', 'unstructured')
-    top : ndarray(float)
+    top : float or ndarray
         top elevations of cells in topmost layer
-    botm : ndarray(float)
+    botm : float or ndarray
         bottom elevations of all cells
-    idomain : ndarray(int)
+    idomain : int or ndarray
         ibound/idomain value for each cell
-    lenuni : ndarray(int)
+    lenuni : int or ndarray
         model length units
     crs : pyproj.CRS, optional if `prj` is specified
         Coordinate reference system (CRS) for the model grid
@@ -65,11 +65,11 @@ class Grid:
     ----------
     grid_type : enumeration
         type of model grid ('structured', 'vertex', 'unstructured')
-    top : ndarray(float)
+    top : float or ndarray
         top elevations of cells in topmost layer
-    botm : ndarray(float)
+    botm : float or ndarray
         bottom elevations of all cells
-    idomain : ndarray(int)
+    idomain : int or ndarray
         ibound/idomain value for each cell
     crs : pyproj.CRS
         Coordinate reference system (CRS) for the model grid

diff --git a/flopy/discretization/structuredgrid.py b/flopy/discretization/structuredgrid.py
@@ -85,17 +85,17 @@ class for a structured model grid
 
     Parameters
     ----------
-    delr : ndarray(float)
+    delr : float or ndarray
         column spacing along a row.
-    delc : ndarray(float)
+    delc : float or ndarray
         row spacing along a column.
-    top : ndarray(float)
+    top : float or ndarray
         top elevations of cells in topmost layer
-    botm : ndarray(float)
+    botm : float or ndarray
         bottom elevations of all cells
-    idomain : ndarray(int)
+    idomain : int or ndarray
         ibound/idomain value for each cell
-    lenuni : ndarray(int)
+    lenuni : int or ndarray
         model length units
     crs : pyproj.CRS, optional if `prj` is specified
         Coordinate reference system (CRS) for the model grid

diff --git a/flopy/discretization/unstructuredgrid.py b/flopy/discretization/unstructuredgrid.py
@@ -36,9 +36,9 @@ class UnstructuredGrid(Grid):
         top elevations for all cells in the grid.
     botm : list or ndarray
         bottom elevations for all cells in the grid.
-    idomain : ndarray(int)
+    idomain : int or ndarray
         ibound/idomain value for each cell
-    lenuni : ndarray(int)
+    lenuni : int or ndarray
         model length units
     ncpl : ndarray
         one dimensional array of size nlay with the number of cells in each

diff --git a/flopy/discretization/vertexgrid.py b/flopy/discretization/vertexgrid.py
@@ -23,9 +23,9 @@ class for a vertex model grid
         top elevations for all cells in the grid.
     botm : list or ndarray
         bottom elevations for all cells in the grid.
-    idomain : ndarray(int)
+    idomain : int or ndarray
         ibound/idomain value for each cell
-    lenuni : ndarray(int)
+    lenuni : int or ndarray
         model length units
     crs : pyproj.CRS, optional if `prj` is specified
         Coordinate reference system (CRS) for the model grid