Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix type hierarchy for CorrectedImageStack, ImagingRetinotopy; improve docs #962

Merged
merged 13 commits into from
Jun 11, 2019
8 changes: 5 additions & 3 deletions src/pynwb/data/nwb.base.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
datasets:
- neurodata_type_def: NWBData
doc: 'The attributes specified here are included in all interfaces.'
doc: An abstract data type for a dataset
attributes:
- name: help
dtype: text
Expand Down Expand Up @@ -93,14 +93,16 @@ datasets:
- 4
groups:
- neurodata_type_def: NWBContainer
doc: The attributes specified here are included in all interfaces.
doc: An abstract data type for a generic container storing collections of data
and metadata. Base type for all data and metadata containers.
attributes:
- name: help
dtype: text
doc: Short description of what this type of NWBContainer contains.
- neurodata_type_def: NWBDataInterface
neurodata_type_inc: NWBContainer
doc: An abstract data type for differentiating experimental data from metadata
doc: An abstract data type for a generic container storing collections of data,
as opposed to metadata.
- neurodata_type_def: TimeSeries
neurodata_type_inc: NWBDataInterface
doc: General purpose time series.
Expand Down
2 changes: 1 addition & 1 deletion src/pynwb/data/nwb.ophys.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -303,7 +303,7 @@ groups:
motion
groups:
- neurodata_type_def: CorrectedImageStack
neurodata_type_inc: NWBContainer
neurodata_type_inc: NWBDataInterface
doc: One of possibly many. Name should be informative.
attributes:
- name: help
Expand Down
2 changes: 1 addition & 1 deletion src/pynwb/data/nwb.retinotopy.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
groups:
- neurodata_type_def: ImagingRetinotopy
neurodata_type_inc: NWBContainer
neurodata_type_inc: NWBDataInterface
doc: 'Intrinsic signal optical imaging or widefield imaging for measuring retinotopy.
Stores orthogonal maps (e.g., altitude/azimuth; radius/theta) of responses to
specific stimuli and a combined polarity map from which to identify visual areas.<br
Expand Down
4 changes: 2 additions & 2 deletions src/pynwb/ecephys.py
Original file line number Diff line number Diff line change
Expand Up @@ -156,8 +156,8 @@ class EventDetection(NWBDataInterface):
'source_idx',
'times')

_help_statement = ("Description of how events were detected, such as voltage "
"threshold, or dV/dT threshold, as well as relevant values.")
__help = ("Description of how events were detected, such as voltage "
"threshold, or dV/dT threshold, as well as relevant values.")

@docval({'name': 'detection_method', 'type': str,
'doc': 'Description of how events were detected, such as voltage threshold, or dV/dT threshold, \
Expand Down