From 761a0d7838304864643f8bc3ab88c93bfd437f2a Mon Sep 17 00:00:00 2001 From: Ryan Ly Date: Tue, 14 Jun 2022 18:17:21 +0100 Subject: [PATCH] Prepare 2.5.0 release (#511) --- core/nwb.file.yaml | 2 +- core/nwb.namespace.yaml | 2 +- docs/format/source/conf.py | 2 +- docs/format/source/format_release_notes.rst | 12 ++++++------ 4 files changed, 9 insertions(+), 9 deletions(-) diff --git a/core/nwb.file.yaml b/core/nwb.file.yaml index cb174de9..cac8918c 100644 --- a/core/nwb.file.yaml +++ b/core/nwb.file.yaml @@ -7,7 +7,7 @@ groups: attributes: - name: nwb_version dtype: text - value: "2.5.0-alpha" + value: "2.5.0" doc: File version string. Use semantic versioning, e.g. 1.2.1. This will be the name of the format with trailing major, minor and patch numbers. datasets: diff --git a/core/nwb.namespace.yaml b/core/nwb.namespace.yaml index 59e2f641..06618b81 100644 --- a/core/nwb.namespace.yaml +++ b/core/nwb.namespace.yaml @@ -57,4 +57,4 @@ namespaces: - doc: This source module contains neurodata_type for retinotopy data. source: nwb.retinotopy.yaml title: Retinotopy - version: "2.5.0-alpha" + version: "2.5.0" diff --git a/docs/format/source/conf.py b/docs/format/source/conf.py index ff469845..2f9ac477 100644 --- a/docs/format/source/conf.py +++ b/docs/format/source/conf.py @@ -85,7 +85,7 @@ def setup(app): # The short X.Y version. version = '2.5.0' # The full version, including alpha/beta/rc tags. -release = '2.5.0-alpha' +release = '2.5.0' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/docs/format/source/format_release_notes.rst b/docs/format/source/format_release_notes.rst index 00c881a9..dd11b616 100644 --- a/docs/format/source/format_release_notes.rst +++ b/docs/format/source/format_release_notes.rst @@ -3,7 +3,7 @@ Release Notes ============= -2.5.0 (Upcoming) +2.5.0 (June 14, 2022) --------------------- Major changes @@ -12,20 +12,20 @@ Major changes Minor changes ^^^^^^^^^^^^^ -- The elements `x`, `y`, `z`, `imp` and `filtering` are now optional instead of required. -- Added an ``offset`` attribute to all ``TimeSeries`` objects to allow enhanced translation to scientific units. +- The elements `x`, `y`, `z`, `imp` and `filtering` are now optional instead of required. (#506) +- Added an ``offset`` attribute to all ``TimeSeries`` objects to allow enhanced translation to scientific units. (#494) - Allowed ``NWBFile/stimulus/templates`` to contain ``Images`` objects. (#459) - Added new optional "order_of_images" dataset to ``Images`` that contains an ordered list of object references to ``Image`` objects stored in the same ``Images`` object. This dataset must be used if the images are referred to - by index, e.g., from an ``IndexSeries`` object. Created new neurodata type ImageReferences which should be used + by index, e.g., from an ``IndexSeries`` object. Created new neurodata type ``ImageReferences`` which should be used for this dataset. (#459, #518, #519, #520) - Overhauled ``IndexSeries`` type (#459): - Fixed dtype of ``data`` dataset of ``IndexSeries`` (int32 -> uint32). - Updated ``unit`` attribute of ``data`` to have fixed value "N/A". - - Updated docstrings for the ``conversion`` and ``resolution`` attributes of ``data`` to indicate that + - Updated docstrings for the ``conversion``, ``resolution``, and ``offset`` attributes of ``data`` to indicate that these fields are not used. - Added link to an ``Images`` object, which contains an ordered collection of images. - Discouraged use of the ``indexed_timeseries`` link to an ``ImageSeries``. + - Discouraged use of the ``indexed_timeseries`` link to an ``ImageSeries``. - Updated ``TimeIntervals`` to use the new ``TimeSeriesReferenceVectorData`` type. This does not alter the overall structure of ``TimeIntervals`` in a major way aside from changing the value of the ``neurodata_type`` attribute in the file from ``VectorData`` to ```TimeSeriesReferenceVectorData``. This change replaces the existing ``TimeIntervals.timeseries``