Skip to content

Commit 47de1d5

Browse files
committed
fix docstrings
1 parent bc95946 commit 47de1d5

File tree

2 files changed

+10
-11
lines changed

2 files changed

+10
-11
lines changed

element_array_ephys/ephys_report.py

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1-
import pathlib
21
import datetime
2+
import pathlib
3+
34
import datajoint as dj
5+
46
from . import probe
57

68
schema = dj.schema()
@@ -13,7 +15,7 @@ def activate(schema_name, ephys_schema_name, *, create_schema=True, create_table
1315
1416
Args:
1517
schema_name (str): schema name on the database server to activate the `ephys_report` schema.
16-
ephys_schema_name (str): schema name of the activated ephys element for which
18+
ephys_schema_name (str): schema name of the activated ephys element for which
1719
this ephys_report schema will be downstream from.
1820
create_schema (bool, optional): If True (default), create schema in the database if it does not yet exist.
1921
create_tables (bool, optional): If True (default), create tables in the database if they do not yet exist.
@@ -97,7 +99,7 @@ class UnitLevelReport(dj.Computed):
9799
"""Table for storing unit level figures.
98100
99101
Attributes:
100-
ephys.CuratedClustering (foreign key): ephys.CuratedClustering primary key.
102+
ephys.CuratedClustering.Unit (foreign key): ephys.CuratedClustering.Unit primary key.
101103
ephys.ClusterQualityLabel (foreign key): ephys.ClusterQualityLabel primary key.
102104
waveform_plotly (longblob): Figure object for unit waveform.
103105
autocorrelogram_plotly (longblob): Figure object for an autocorrelogram.
@@ -107,19 +109,16 @@ class UnitLevelReport(dj.Computed):
107109
definition = """
108110
-> ephys.CuratedClustering.Unit
109111
---
110-
-> ephys.ClusterQualityLabel
111-
waveform_plotly : longblob
112+
-> ephys.ClusterQualityLabel
113+
waveform_plotly : longblob
112114
autocorrelogram_plotly : longblob
113115
depth_waveform_plotly : longblob
114116
"""
115117

116118
def make(self, key):
117119

118-
from .plotting.unit_level import (
119-
plot_waveform,
120-
plot_auto_correlogram,
121-
plot_depth_waveforms,
122-
)
120+
from .plotting.unit_level import (plot_auto_correlogram,
121+
plot_depth_waveforms, plot_waveform)
123122

124123
sampling_rate = (ephys.EphysRecording & key).fetch1(
125124
"sampling_rate"

element_array_ephys/plotting/unit_level.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ def plot_depth_waveforms(
9797
unit_key: dict[str, Any],
9898
y_range: float = 60,
9999
) -> go.Figure:
100-
"""Plot the peak waveform (in red) and waveforms from its neighboring channels on a spatial coordinate.
100+
"""Plot the peak waveform (in red) and waveforms from its neighboring sites on a spatial coordinate.
101101
102102
Args:
103103
ephys (Module): Imported ephys module object.

0 commit comments

Comments
 (0)