Skip to content

Commit 7cf336c

Browse files
committed
Remove notes and update docstrings
1 parent df7810a commit 7cf336c

2 files changed

Lines changed: 21 additions & 3 deletions

File tree

modflowapi/extensions/data.py

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -276,13 +276,19 @@ def _recarray_to_ptr(self, recarray):
276276

277277
def _special_condition_to_values(self, ctype, inval):
278278
"""
279+
Method to catch and set special, compound conditions where necessary data
280+
is not directly available from MODFLOW
279281
280282
Parameters
281283
----------
282-
sp_cond
284+
ctype : str
285+
condition type
286+
inval : int, float, np.ndarray
287+
input data value
283288
284289
Returns
285290
-------
291+
outval : np.array of values
286292
"""
287293
functions = {
288294
"range": lambda x: np.arange(0, int(x), dtype=int),
@@ -300,13 +306,22 @@ def _special_condition_to_values(self, ctype, inval):
300306

301307
def _special_condition_to_ptr(self, recarray, name, visited):
302308
"""
309+
Method to catch and set special, compound conditions to the associated MODFLOW
310+
ptr where the user data is not directly available from MODFLOW
303311
304312
Parameters
313+
----------
314+
recarray : np.recarray
315+
recarray of user data
316+
name : str
317+
data column name
318+
visited : list
319+
list of visited data columns used to avoid duplicate processing
305320
306321
307322
Returns
308323
-------
309-
324+
visited : list
310325
"""
311326
functions = {
312327
"range": lambda x: [

modflowapi/extensions/pakbase.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -478,7 +478,6 @@ def __init__(self, model, pkg_type, pkg_name, sim_package=False):
478478
# create variable addresses!!!!
479479
for var in self._adv_var_dict["perioddata"]:
480480
if isinstance(var, tuple):
481-
# todo: check if there's a compound variable in bound
482481
use_bound = True
483482
for v in var[-1]:
484483
if ":" in v:
@@ -566,6 +565,10 @@ def packagedata(self, recarray):
566565
"""
567566
Setter method to update the packagedata
568567
568+
Parameters
569+
----------
570+
recarray : np.recarray, ListInput, or None
571+
569572
"""
570573
if self._package_vars is not None:
571574
if isinstance(recarray, np.recarray):

0 commit comments

Comments
 (0)