Skip to content

Commit acdb5f9

Browse files
committed
fix docstring for get_electrodes_mapping
1 parent 826335b commit acdb5f9

File tree

1 file changed

+7
-3
lines changed
  • element_array_ephys/export/nwb

1 file changed

+7
-3
lines changed

element_array_ephys/export/nwb/nwb.py

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -293,7 +293,7 @@ def add_ephys_units_to_nwb(
293293

294294
def get_electrodes_mapping(electrodes):
295295
"""
296-
Create a mapping from the group (shank) and electrode id within that group to the row number of the electrodes
296+
Create a mapping from the probe and electrode id to the row number of the electrodes
297297
table. This is used in the construction of the DynamicTableRegion that indicates what rows of the electrodes
298298
table correspond to the data in an ElectricalSeries.
299299
@@ -342,8 +342,11 @@ def gains_helper(gains):
342342

343343

344344
def add_ephys_recording_to_nwb(
345-
session_key: dict, ephys_root_data_dir,
346-
nwbfile: pynwb.NWBFile, end_frame: int = None):
345+
session_key: dict,
346+
ephys_root_data_dir: str,
347+
nwbfile: pynwb.NWBFile,
348+
end_frame: int = None,
349+
):
347350
"""
348351
Read voltage data directly from source files and iteratively transfer them to the NWB file. Automatically
349352
applies lossless compression to the data, so the final file might be smaller than the original, without
@@ -354,6 +357,7 @@ def add_ephys_recording_to_nwb(
354357
Parameters
355358
----------
356359
session_key: dict
360+
ephys_root_data_dir: str
357361
nwbfile: NWBFile
358362
end_frame: int, optional
359363
Used for small test conversions

0 commit comments

Comments
 (0)