Skip to content

Commit d831bcf

Browse files
committed
maint: apply suggested renames
1 parent 5be1ed2 commit d831bcf

File tree

1 file changed

+7
-10
lines changed

1 file changed

+7
-10
lines changed

hnn_core/cells_default.py

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -319,11 +319,9 @@ def _exp_g_at_dist(x, zero_val, exp_term, offset, slope=1):
319319
slope : int | float, default=1
320320
Slope of the exponential component
321321
"""
322-
# AES: TODO Should the offset be multiplied by zero_val? This was also changed in
323-
# #1168, but seems suspicious to me... It currently passes tests, BUT it appears
324-
# that offset is always 0 in every use case used so far, so if this introduces a
325-
# bug, it will not be detected...
326-
return zero_val * (slope * np.exp(exp_term * x) + offset)
322+
# AES TODO rename zero_val
323+
gbar = zero_val * (slope * np.exp(exp_term * x) + offset)
324+
return gbar
327325

328326

329327
def basket(cell_name, pos=(0, 0, 0), gid=None):
@@ -394,7 +392,7 @@ def pyramidal(cell_name, pos=(0, 0, 0), override_params=None, gid=None):
394392
raise ValueError(f"Unknown pyramidal cell type: {cell_name}")
395393

396394

397-
def _linear_g_at_dist(x, gsoma, gdend, xkink, hotzone_factor=1, hotzone=[0, 0]):
395+
def _linear_g_at_dist(x, gsoma, gdend, xkink, hotzone_factor=1, hotzone_boundaries=[0, 0]):
398396
"""Compute linear distance-dependent ionic conductance.
399397
400398
Parameters
@@ -409,10 +407,9 @@ def _linear_g_at_dist(x, gsoma, gdend, xkink, hotzone_factor=1, hotzone=[0, 0]):
409407
Plateau value where conductance is fixed at gdend.
410408
hotzone_factor: int | float, default=1
411409
Increase in conducivity that creates a hotzone.
412-
hotzone : [float, float]
413-
TODO: AES: Seems to be the start and end distance of the hotzone. Should prob be
414-
renamed to `hotzone_boundaries` or something like that. Start and end of
415-
hotzone if hotzone_factor > 1. Units are the same as that of `x`.
410+
hotzone_boundaries : [float, float]
411+
Start and end of hotzone if hotzone_factor > 1. Units are the same as that of
412+
`x`.
416413
417414
Notes
418415
-----

0 commit comments

Comments
 (0)