From 1b0078c8cc7b09c68ab824982d6184114cc52b39 Mon Sep 17 00:00:00 2001 From: Steph Prince <40640337+stephprince@users.noreply.github.com> Date: Tue, 16 Jan 2024 14:36:11 -0800 Subject: [PATCH] replace colons in docstrings for sphinx doc building --- src/pynwb/icephys.py | 26 +++++++++++++------------- src/pynwb/image.py | 2 +- src/pynwb/misc.py | 2 +- src/pynwb/ophys.py | 6 +++--- src/pynwb/retinotopy.py | 4 ++-- 5 files changed, 20 insertions(+), 20 deletions(-) diff --git a/src/pynwb/icephys.py b/src/pynwb/icephys.py index 04382abbc..2de21d571 100644 --- a/src/pynwb/icephys.py +++ b/src/pynwb/icephys.py @@ -48,7 +48,7 @@ class IntracellularElectrode(NWBContainer): {'name': 'seal', 'type': str, 'doc': 'Information about seal used for recording.', 'default': None}, {'name': 'location', 'type': str, 'doc': 'Area, layer, comments on estimation, stereotaxis coordinates (if in vivo, etc).', 'default': None}, - {'name': 'resistance', 'type': str, 'doc': 'Electrode resistance, unit: Ohm.', 'default': None}, + {'name': 'resistance', 'type': str, 'doc': 'Electrode resistance, unit - Ohm.', 'default': None}, {'name': 'filtering', 'type': str, 'doc': 'Electrode specific filtering.', 'default': None}, {'name': 'initial_access_resistance', 'type': str, 'doc': 'Initial access resistance.', 'default': None}, {'name': 'cell_id', 'type': str, 'doc': 'Unique ID of cell.', 'default': None} @@ -164,11 +164,11 @@ class CurrentClampSeries(PatchClampSeries): 'capacitance_compensation') @docval(*get_docval(PatchClampSeries.__init__, 'name', 'data', 'electrode'), # required - {'name': 'gain', 'type': float, 'doc': 'Units: Volt/Volt'}, + {'name': 'gain', 'type': float, 'doc': 'Units - Volt/Volt'}, *get_docval(PatchClampSeries.__init__, 'stimulus_description'), - {'name': 'bias_current', 'type': float, 'doc': 'Unit: Amp', 'default': None}, - {'name': 'bridge_balance', 'type': float, 'doc': 'Unit: Ohm', 'default': None}, - {'name': 'capacitance_compensation', 'type': float, 'doc': 'Unit: Farad', 'default': None}, + {'name': 'bias_current', 'type': float, 'doc': 'Unit - Amp', 'default': None}, + {'name': 'bridge_balance', 'type': float, 'doc': 'Unit - Ohm', 'default': None}, + {'name': 'capacitance_compensation', 'type': float, 'doc': 'Unit - Farad', 'default': None}, *get_docval(PatchClampSeries.__init__, 'resolution', 'conversion', 'timestamps', 'starting_time', 'rate', 'comments', 'description', 'control', 'control_description', 'sweep_number', 'offset'), {'name': 'unit', 'type': str, 'doc': "The base unit of measurement (must be 'volts')", @@ -267,15 +267,15 @@ class VoltageClampSeries(PatchClampSeries): 'whole_cell_series_resistance_comp') @docval(*get_docval(PatchClampSeries.__init__, 'name', 'data', 'electrode'), # required - {'name': 'gain', 'type': float, 'doc': 'Units: Volt/Amp'}, # required + {'name': 'gain', 'type': float, 'doc': 'Units - Volt/Amp'}, # required *get_docval(PatchClampSeries.__init__, 'stimulus_description'), - {'name': 'capacitance_fast', 'type': float, 'doc': 'Unit: Farad', 'default': None}, - {'name': 'capacitance_slow', 'type': float, 'doc': 'Unit: Farad', 'default': None}, - {'name': 'resistance_comp_bandwidth', 'type': float, 'doc': 'Unit: Hz', 'default': None}, - {'name': 'resistance_comp_correction', 'type': float, 'doc': 'Unit: percent', 'default': None}, - {'name': 'resistance_comp_prediction', 'type': float, 'doc': 'Unit: percent', 'default': None}, - {'name': 'whole_cell_capacitance_comp', 'type': float, 'doc': 'Unit: Farad', 'default': None}, - {'name': 'whole_cell_series_resistance_comp', 'type': float, 'doc': 'Unit: Ohm', 'default': None}, + {'name': 'capacitance_fast', 'type': float, 'doc': 'Unit - Farad', 'default': None}, + {'name': 'capacitance_slow', 'type': float, 'doc': 'Unit - Farad', 'default': None}, + {'name': 'resistance_comp_bandwidth', 'type': float, 'doc': 'Unit - Hz', 'default': None}, + {'name': 'resistance_comp_correction', 'type': float, 'doc': 'Unit - percent', 'default': None}, + {'name': 'resistance_comp_prediction', 'type': float, 'doc': 'Unit - percent', 'default': None}, + {'name': 'whole_cell_capacitance_comp', 'type': float, 'doc': 'Unit - Farad', 'default': None}, + {'name': 'whole_cell_series_resistance_comp', 'type': float, 'doc': 'Unit - Ohm', 'default': None}, *get_docval(PatchClampSeries.__init__, 'resolution', 'conversion', 'timestamps', 'starting_time', 'rate', 'comments', 'description', 'control', 'control_description', 'sweep_number', 'offset'), {'name': 'unit', 'type': str, 'doc': "The base unit of measurement (must be 'amperes')", diff --git a/src/pynwb/image.py b/src/pynwb/image.py index 0295183b8..518ec8a8c 100644 --- a/src/pynwb/image.py +++ b/src/pynwb/image.py @@ -46,7 +46,7 @@ class ImageSeries(TimeSeries): 'is specified. If unit (and data) are not specified, then unit will be set to "unknown".'), 'default': None}, {'name': 'format', 'type': str, - 'doc': 'Format of image. Three types: 1) Image format; tiff, png, jpg, etc. 2) external 3) raw.', + 'doc': 'Format of image. Three types - 1) Image format; tiff, png, jpg, etc. 2) external 3) raw.', 'default': None}, {'name': 'external_file', 'type': ('array_data', 'data'), 'doc': 'Path or URL to one or more external file(s). Field only present if format=external. ' diff --git a/src/pynwb/misc.py b/src/pynwb/misc.py index 4d977b4f2..14c2e08d1 100644 --- a/src/pynwb/misc.py +++ b/src/pynwb/misc.py @@ -265,7 +265,7 @@ class DecompositionSeries(TimeSeries): 'shape': (None, None, None)}, *get_docval(TimeSeries.__init__, 'description'), {'name': 'metric', 'type': str, # required - 'doc': "metric of analysis. recommended: 'phase', 'amplitude', 'power'"}, + 'doc': "metric of analysis. recommended - 'phase', 'amplitude', 'power'"}, {'name': 'unit', 'type': str, 'doc': 'SI unit of measurement', 'default': 'no unit'}, {'name': 'bands', 'type': DynamicTable, 'doc': 'a table for describing the frequency bands that the signal was decomposed into', 'default': None}, diff --git a/src/pynwb/ophys.py b/src/pynwb/ophys.py index e3d9f8f6d..bdff47592 100644 --- a/src/pynwb/ophys.py +++ b/src/pynwb/ophys.py @@ -57,15 +57,15 @@ class ImagingPlane(NWBContainer): 'doc': 'Rate images are acquired, in Hz. If the corresponding TimeSeries is present, the rate should be ' 'stored there instead.', 'default': None}, {'name': 'manifold', 'type': 'array_data', - 'doc': ('DEPRECATED: Physical position of each pixel. size=("height", "width", "xyz"). ' + 'doc': ('DEPRECATED - Physical position of each pixel. size=("height", "width", "xyz"). ' 'Deprecated in favor of origin_coords and grid_spacing.'), 'default': None}, {'name': 'conversion', 'type': float, - 'doc': ('DEPRECATED: Multiplier to get from stored values to specified unit (e.g., 1e-3 for millimeters) ' + 'doc': ('DEPRECATED - Multiplier to get from stored values to specified unit (e.g., 1e-3 for millimeters) ' 'Deprecated in favor of origin_coords and grid_spacing.'), 'default': 1.0}, {'name': 'unit', 'type': str, - 'doc': 'DEPRECATED: Base unit that coordinates are stored in (e.g., Meters). ' + 'doc': 'DEPRECATED - Base unit that coordinates are stored in (e.g., Meters). ' 'Deprecated in favor of origin_coords_unit and grid_spacing_unit.', 'default': 'meters'}, {'name': 'reference_frame', 'type': str, diff --git a/src/pynwb/retinotopy.py b/src/pynwb/retinotopy.py index a345177c0..fd32037e8 100644 --- a/src/pynwb/retinotopy.py +++ b/src/pynwb/retinotopy.py @@ -123,9 +123,9 @@ class ImagingRetinotopy(NWBDataInterface): 'Description should be something like ["altitude", "azimuth"] or ["radius", "theta"].'}, {'name': 'focal_depth_image', 'type': FocalDepthImage, 'doc': 'Gray-scale image taken with same settings/parameters (e.g., focal depth, wavelength) ' - 'as data collection. Array format: [rows][columns].'}, + 'as data collection. Array format - [rows][columns].'}, {'name': 'vasculature_image', 'type': RetinotopyImage, - 'doc': 'Gray-scale anatomical image of cortical surface. Array structure: [rows][columns].'}, + 'doc': 'Gray-scale anatomical image of cortical surface. Array structure - [rows][columns].'}, {'name': 'name', 'type': str, 'doc': 'the name of this container', 'default': 'ImagingRetinotopy'}) def __init__(self, **kwargs): axis_1_phase_map, axis_1_power_map, axis_2_phase_map, axis_2_power_map, axis_descriptions, \