Skip to content

Commit f11900f

Browse files
author
Thinh Nguyen
committed
update docstring for function activate
1 parent aa4064c commit f11900f

File tree

2 files changed

+8
-1
lines changed

2 files changed

+8
-1
lines changed

elements_ephys/ephys.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,8 @@ def activate(ephys_schema_name, probe_schema_name=None, *, create_schema=True,
2828
required dependencies to activate the `ephys` element:
2929
Upstream tables:
3030
+ Session: parent table to ProbeInsertion, typically identifying a recording session
31-
+ SkullReference:
31+
+ SkullReference: Reference table for InsertionLocation, specifying the skull reference
32+
used for probe insertion location (e.g. Bregma, Lambda)
3233
Functions:
3334
+ get_neuropixels_data_directory(probe_insertion_key: dict) -> str
3435
Retrieve the recorded Neuropixels data directory for a given ProbeInsertion

elements_ephys/probe.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,12 @@
88

99

1010
def activate(schema_name, create_schema=True, create_tables=True):
11+
"""
12+
activate(schema_name, create_schema=True, create_tables=True)
13+
:param schema_name: schema name to activate the `probe` element
14+
:param create_schema: create the schema if not yet existed (default = True)
15+
:param create_tables: create the tables if not yet existed (default = True)
16+
"""
1117
schema.activate(schema_name, create_schema=create_schema, create_tables=create_tables)
1218

1319

0 commit comments

Comments
 (0)