Skip to content

Commit 43a4044

Browse files
committed
chore(analysis): document remaining arguments
1 parent c198ed4 commit 43a4044

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

pyneuroml/analysis/__init__.py

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -112,8 +112,8 @@ def generate_current_vs_frequency_curve(
112112
:type temperature: str
113113
:param spike_threshold_mV: spike threshold potential
114114
:type spike_threshold_mV: float
115-
:param plot_voltage_traces:
116-
:type plot_voltage_traces:
115+
:param plot_voltage_traces: toggle plotting of voltage traces
116+
:type plot_voltage_traces: bool
117117
:param plot_if: toggle whether to plot I-F graphs
118118
:type plot_if: bool
119119
:param plot_iv: toggle whether to plot I-V graphs
@@ -159,19 +159,19 @@ def generate_current_vs_frequency_curve(
159159
:type simulator: str
160160
:param num_processors: number of processors to use for analysis
161161
:type num_processors: int
162-
:param include_included:
163-
:type include_included:
164-
:param title_above_plot:
165-
:type title_above_plot:
162+
:param include_included: include included files
163+
:type include_included: bool
164+
:param title_above_plot: title to show above the plot
165+
:type title_above_plot: str
166166
:param return_axes: toggle whether plotting axis should be returned.
167167
This is useful if one wants to overlay more graphs in the same plot.
168168
:type return_axes: bool
169169
:param segment_id: segment id to attach input to
170170
:type segment_id: str
171171
:param fraction_along: fraction along on segment to attach to
172172
:type fraction_along: float
173-
:param verbose:
174-
:type verbose:
173+
:param verbose: toggle verbosity
174+
:type verbose: bool
175175
176176
"""
177177

0 commit comments

Comments
 (0)