Skip to content

Commit 910492f

Browse files
h-mayorquinzm711
andauthored
Apply suggestions from code review
Thanks a bunch Zach Co-authored-by: Zach McKenzie <92116279+zm711@users.noreply.github.com>
1 parent f0fae94 commit 910492f

1 file changed

Lines changed: 8 additions & 8 deletions

File tree

src/spikeinterface/core/generate.py

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2016,22 +2016,22 @@ def generate_unit_locations(
20162016
channel_locations : numpy.ndarray
20172017
A 2D array of shape (num_channels, 2), where each row represents the (x, y) coordinates
20182018
of a channel.
2019-
margin_um : float, default 20.0
2019+
margin_um : float, default: 20.0
20202020
The margin to add around the minimum and maximum x and y channel coordinates when
20212021
generating unit locations
2022-
minimum_z : float, default 5.0
2022+
minimum_z : float, default: 5.0
20232023
The minimum z-coordinate value for generated unit locations.
2024-
maximum_z : float, default 40.0
2024+
maximum_z : float, default: 40.0
20252025
The maximum z-coordinate value for generated unit locations.
2026-
minimum_distance : float, default 20.0
2026+
minimum_distance : float, default: 20.0
20272027
The minimum allowable distance in micrometers between any two units
2028-
max_iteration : int, default 100
2028+
max_iteration : int, default: 100
20292029
The maximum number of iterations to attempt generating unit locations that meet
2030-
the minimum distance constraint (default is 100).
2031-
distance_strict : bool, optionaldefault False
2030+
the minimum distance constraint.
2031+
distance_strict : bool, default: False
20322032
If True, the function will raise an exception if a solution meeting the distance
20332033
constraint cannot be found within the maximum number of iterations. If False, a warning
2034-
will be issued (default is False).
2034+
will be issued.
20352035
seed : int or None, optional
20362036
Random seed for reproducibility. If None, the seed is not set
20372037

0 commit comments

Comments
 (0)