Skip to content

Commit 1f7bb18

Browse files
committed
change to np docstring format
1 parent c1dad6c commit 1f7bb18

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

src/trodes_to_nwb/convert_optogenetics.py

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -82,12 +82,14 @@ def make_optogenetic_source(
8282
) -> ExcitationSource:
8383
"""Create an ExcitationSource object and add it to the NWB file.
8484
85-
Args:
85+
Parameters:
86+
----------
8687
nwbfile (NWBFile): The NWB file to which the excitation source will be added.
8788
source_metadata (dict): Metadata for the excitation source.
8889
device_metadata (List[dict]): Metadata for the excitation device used in the experiment.
8990
9091
Returns:
92+
-------
9193
ExcitationSource: The created ExcitationSource object.
9294
"""
9395
model_metadata = get_optogenetic_source_device(
@@ -120,12 +122,14 @@ def make_optical_fiber(
120122
) -> OpticalFiber:
121123
"""Create an OpticalFiberLocationsTable and populate it with optical fiber data.
122124
123-
Args:
125+
Parameters:
126+
----------
124127
nwbfile (NWBFile): The NWB file to which the optical fiber locations table will be added.
125128
fiber_metadata_list (dict): Metadata for the optical fibers.
126129
excitation_source (ExcitationSource): The excitation source associated with the optical fibers.
127130
128131
Returns:
132+
-------
129133
OpticalFiber: The created OpticalFiber object.
130134
"""
131135
# make the locations table
@@ -608,10 +612,12 @@ def get_condition_ids(metadata_dict: dict) -> List[str]:
608612
"""
609613
Recursively extracts condition IDs from a metadata dictionary.
610614
611-
Args:
615+
Parameters:
616+
----------
612617
metadata_dict (dict): A dictionary containing metadata, which may
613618
include nested children.
614619
Returns:
620+
-------
615621
List[str]: A list of condition IDs extracted from the metadata. Corresponds
616622
to the extracted keys in the protocol_metadata
617623
"""

0 commit comments

Comments
 (0)