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.

Sign up for GitHub

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

Jump to bottom

Deprecate region references #39

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Deprecate region references #39

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions source/description.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -614,26 +614,26 @@ data objects. Reference ``dtypes`` are described via a dictionary. E.g.:
.. code-block:: yaml

dtype:
target_type: ElectrodeGroup
reftype: object
target_type: ElectrodeGroup
reftype: object


``target_type`` here describes the ``data_type`` of the target that the reference points to and
``reftype`` describes the kind of reference. Currently the specification language supports two main
reference types.
``reftype`` describes the kind of reference. Currently the specification language supports one
type of reference: object references.

+--------------------------+-------------------------------------+
| ``reftype`` **value** | **Reference type description** |
+--------------------------+-------------------------------------+
| * "ref" | Reference to another group or |
| * "reference" | dataset of the given |
| * "object" | ``target_type`` |
+--------------------------+-------------------------------------+
| * region | Reference to a region (i.e. subset) |
| | of another dataset of the given |
| * "object" | Reference to another group or |
| | dataset of the given |
| | ``target_type`` |
+--------------------------+-------------------------------------+

.. note::

In version 3.0, "region" references were removed. Now, ``reftype`` always refers to an object reference.

Compound ``dtype``
""""""""""""""""""

Expand Down
4 changes: 2 additions & 2 deletions source/hdmf.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,9 +170,9 @@
"type": "string"
},
"reftype": {
"description": "describes the kind of reference",
"description": "Describes the kind of reference",
"type": "string",
"enum": ["ref", "reference", "object", "region"]
"enum": ["object"]
}
}
},
Expand Down
2 changes: 2 additions & 0 deletions source/release_notes.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ Version 3.0.0 (Upcoming)
* Changed the meaning of the default shape ``shape: null`` from representing a scalar to representing any shape.
* Added special value for ``shape: scalar`` that represents a scalar.

* Deprecated region references and the "reftype: ref" and "reftype: reference" aliases for object references.

Version 2.0.2 (March, 2020)
---------------------------------
* add ``value`` and ``default_value`` as optional keys of a dataset.
Expand Down