Skip to content

Commit b2922e2

Browse files
committed
Added documentation for new doc/title keys for sources as part of the namespace schema
1 parent 371e72d commit b2922e2

File tree

2 files changed

+12
-1
lines changed

2 files changed

+12
-1
lines changed

docs/language/source/specification_language_description.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,8 @@ The specification of a namespace looks as follows:
113113
schema:
114114
- source: nwb.base.yaml
115115
neurodata_types: null
116+
doc : Base nwb types
117+
title : Base types
116118
- ...
117119
118120
The top-level key must be ``namespaces``. The value of ``namespaces``
@@ -167,6 +169,8 @@ List of the schema to be included in this namespace. The specification looks as
167169
168170
- source: nwb.base.yaml
169171
- source: nwb.ephys.yaml
172+
doc: Types related to EPhys
173+
title: EPhys
170174
neurodata_types: ElectricalSeries
171175
- namespace: core
172176
neurodata_types: Interface
@@ -176,6 +180,9 @@ List of the schema to be included in this namespace. The specification looks as
176180
* ``neurodata_types`` then is an optional list of strings indicating which neurodata_types should be
177181
included from the given specification source or namespace. The default is ``neurodata_types: null`` indicating that all
178182
neurordata_types should be included.
183+
* ``doc`` is an optional key for source files with a doc string to further document the content of the source file.
184+
* ``title`` is an option key for source files to provide a descriptive title for a file for documentation purposes.
185+
179186

180187
.. attention::
181188

docs/language/source/specification_language_release_notes.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,12 @@
22
Release Notes
33
=============
44

5+
Version 2.0.1 (March, 2019)
6+
---------------------------------
7+
* Added support for specifying a ``title`` and ``doc`` for ``source`` files as part of the ``schema`` portion of a ``namespace`` specification
58

6-
Version 2.0.0alpha (August, 2017)
9+
10+
Version 2.0.0 (January, 2019)
711
----------------------------------
812

913
Summary

0 commit comments

Comments
 (0)