Skip to content

Commit 62c7340

Browse files
authored
Update release notes with missing notes, fix formatting (#386)
* Update release notes with missing notes, fix formatting * Update 2.2.0 date
1 parent f206f80 commit 62c7340

File tree

1 file changed

+23
-14
lines changed

1 file changed

+23
-14
lines changed

docs/format/source/format_release_notes.rst

Lines changed: 23 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,56 @@
11
Release Notes
22
=============
33

4-
2.2.0 (Upcoming)
4+
2.2.0 (January 6, 2020)
55
----------------
66

7-
- Moved common data structures such as Container and DynamicTable to hdmf.common.
7+
- Moved common data structures such as Container and DynamicTable to hdmf-common-schema.
88

99
- The hdmf-common-schema repo is now included as a submodule
1010
- See https://github.com/NeurodataWithoutBorders/nwb-schema/pull/307 for details
1111

12-
- Added "channel_conversion" dataset to ElectricalSeries to represent per-channel conversion factors
12+
- Added "channel_conversion" dataset to ElectricalSeries to represent per-channel conversion factors.
1313

14-
- Added "sampling_rate" and "unit" attributes to "waveform_mean" and "waveform_sd" datasets/columns in Units table
14+
- Added "sampling_rate" and "unit" attributes to "waveform_mean" and "waveform_sd" datasets/columns in Units table.
15+
16+
- Added "description" and "manufacturer" attributes to Device.
1517

1618
- Deprecated ImagingPlane "manifold" in favor of "origin_coords" and "grid_spacing"
1719

1820
- Use "text" data type for all DynamicTable "colnames". Previously, only ASCII was allowed.
1921

2022
- Use "text" data type for electrode table columns "location" and "group_name". Previously, only ASCII was allowed.
2123

22-
- Add to description to make electrode x,y,z consistent with CCF reference http://help.brain-map.org/display/mousebrain/API#API-DownloadAtlas3-DReferenceModels
24+
- Added to description to make electrode x,y,z consistent with CCF reference. http://help.brain-map.org/display/mousebrain/API#API-DownloadAtlas3-DReferenceModels
25+
26+
- Added "position" dataset with compound data type x,y,z in ElectrodeGroup.
2327

2428
- Avoid enforcing "uint64" for sweep numbers for better compatibility. Use uint instead which is 32bit.
2529

2630
- Set `dtype` for `Image` and its subtypes to `numeric`. (note: technically this breaks backwards compatibility, in the schema, but the `pynwb` API has always enforced that Images have a numeric type, and realistically we do not think users are storing strings in an `Image` dataset.)
2731

28-
- Change the "quantity" key of attribute Units.resolution to "required" for schema language compliance.
32+
- Added "resolution" attribute to "spike_times" column of Units.
33+
34+
- Changed the "quantity" key of attribute Units.resolution to "required" for schema language compliance.
35+
36+
- Removed "required" key from dataset ImageSeries.field_of_view for schema language compliance.
37+
38+
- Replaced "required" keys with "quantity" keys for ImagingPlane.origin_coords and ImagingPlane.grid_spacing for schema language compliance.
2939

30-
- Remove "required" key from dataset ImageSeries.field_of_view for schema language compliance
40+
- Refactored ImagingRetinotopy type to reduce redundancy.
3141

32-
- Replace "required" keys with "quantity" keys for ImagingPlane.origin_coords and ImagingPlane.grid_spacing for schema language compliance
42+
- Added "doc" key to ImagingRetinotopy.axis_2_power_map for schema language compliance.
3343

34-
- Add "doc" key to ImagingRetinotopy.axis_2_power_map for schema language compliance
44+
- Fixed makefiles for generating documentation on Windows.
3545

36-
- Fix makefiles for generating documentation on Windows.
46+
- Added optional "reference" column in "electrodes" table.
3747

38-
- Add optional "reference" column in "electrodes" table
48+
- Changed dims of ImageSeries from (frame, y, x) to (frame, x, y) and (frame, z, y, x) to (frame, x, y, z) to be consistent with the dimension ordering in PlaneSegmentation.
3949

40-
- Change dims of ImageSeries from (frame, y, x) to (frame, x, y) and (frame, z, y, x) to (frame, x, y, z) to be consistent with the dimension ordering in PlaneSegmentation.
50+
- Changed dims of Image from (y, x) to (x, y). (note: as far as we know, users of NWB 2.0 that use the Image type encode their data as (x, y)) to be consistent with the dimension ordering in ImageSeries.
4151

42-
- Change dims of Image from (y, x) to (x, y). (note: as far as we know, users of NWB 2.0 that use the Image type encode their data as (x, y)) to be consistent with the dimension ordering in ImageSeries.
52+
- Updated hdmf-common-schema to version 1.1.0 which includes:
4353

44-
- Update hdmf-common-schema to version 1.1.0 which includes:
4554
- The 'colnames' attribute of ``DynamicTable`` changed from data type 'ascii' to 'text'.
4655
- Improved documentation and type docstrings.
4756

0 commit comments

Comments
 (0)