Skip to content

Commit f7cd915

Browse files
committed
Added doc and title for all source files in the core namespace and updated the release notes accordingly
1 parent 36fe2e4 commit f7cd915

File tree

2 files changed

+39
-5
lines changed

2 files changed

+39
-5
lines changed

core/nwb.namespace.yaml

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,36 @@ namespaces:
1414
full_name: NWB core
1515
schema:
1616
- source: nwb.base.yaml
17+
title: Base data types
18+
doc: This source module contains base data types used throughout the NWB:N data format.
1719
- source: nwb.epoch.yaml
20+
title: Epochs
21+
doc: This source module contains neurodata_types for epoch data.
1822
- source: nwb.image.yaml
23+
title: Image data
24+
doc: This source module contains neurodata_types for image data.
1925
- source: nwb.file.yaml
26+
title: NWB:N file
27+
doc: Main NWB:N file specification.
2028
- source: nwb.misc.yaml
29+
title: Miscellaneous neurodata_types.
30+
doc: Miscellaneous types.
2131
- source: nwb.behavior.yaml
32+
title: Behavior
33+
doc: This source module contains neurodata_types for behavior data.
2234
- source: nwb.ecephys.yaml
35+
title: Extracellular electrophysiology
36+
doc: This source module contains neurodata_types for extracellular electrophysiology data.
2337
- source: nwb.icephys.yaml
38+
title: Intracellular electrophysiology
39+
doc: This source module contains neurodata_types for intracellular electrophysiology data.
2440
- source: nwb.ogen.yaml
41+
title: Optogenetics
42+
doc: This source module contains neurodata_types for opto-genetics data.
2543
- source: nwb.ophys.yaml
44+
title: Optical physiology
45+
doc: This source module contains neurodata_types for optical physiology data.
2646
- source: nwb.retinotopy.yaml
27-
version: 2.0.0
47+
title: Retinotopy
48+
doc: This source module contains neurodata_type for retinotopy data.
49+
version: 2.0.1

docs/format/source/format_release_notes.rst

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,24 @@
11
Release Notes
22
=============
33

4-
2.0.0 Beta (2017/18)
5-
--------------------
4+
2.0.1 (March 2019)
5+
------------------
66

7-
**First release:** November 2017
7+
**Change:** Added ``doc`` and ``title`` descriptions for the individual source files included in the main namespace.
8+
9+
**Reason:** Enhance documentation of the namespace and facilitate presentation of types in autogenerated docs by
10+
making it easier to sort ``neurodata_types`` into meaningful categories (i.e., sections) with approbriate tiles and
11+
descriptions.
12+
13+
**Backwards compatibility:** No changes to the actual specification fo the format are made. 2.0.1 is fully compatible
14+
with 2.0.0.
15+
16+
17+
2.0.0 (January 2019)
18+
---------------------
19+
20+
**Main release:** November 2017 (Beta), November 2018 (RC), January 2019 (final)
821

9-
**Subsequent releases:** The schema was improved and updated throughout the beta phase with full release planed for fall 2018.
1022

1123
Added new base data types: ``NWBContainer``, ``NWBData``, ``NWBDataInterface``
1224
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

0 commit comments

Comments
 (0)