Skip to content

Commit

Permalink
Update release notes with missing notes, fix formatting (#386)
Browse files Browse the repository at this point in the history
* Update release notes with missing notes, fix formatting

* Update 2.2.0 date
  • Loading branch information
rly authored Jan 7, 2020
1 parent f206f80 commit 62c7340
Showing 1 changed file with 23 additions and 14 deletions.
37 changes: 23 additions & 14 deletions docs/format/source/format_release_notes.rst
Original file line number Diff line number Diff line change
@@ -1,47 +1,56 @@
Release Notes
=============

2.2.0 (Upcoming)
2.2.0 (January 6, 2020)
----------------

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

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

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

- Added "sampling_rate" and "unit" attributes to "waveform_mean" and "waveform_sd" datasets/columns in Units table
- Added "sampling_rate" and "unit" attributes to "waveform_mean" and "waveform_sd" datasets/columns in Units table.

- Added "description" and "manufacturer" attributes to Device.

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

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

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

- Add to description to make electrode x,y,z consistent with CCF reference http://help.brain-map.org/display/mousebrain/API#API-DownloadAtlas3-DReferenceModels
- Added to description to make electrode x,y,z consistent with CCF reference. http://help.brain-map.org/display/mousebrain/API#API-DownloadAtlas3-DReferenceModels

- Added "position" dataset with compound data type x,y,z in ElectrodeGroup.

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

- 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.)

- Change the "quantity" key of attribute Units.resolution to "required" for schema language compliance.
- Added "resolution" attribute to "spike_times" column of Units.

- Changed the "quantity" key of attribute Units.resolution to "required" for schema language compliance.

- Removed "required" key from dataset ImageSeries.field_of_view for schema language compliance.

- Replaced "required" keys with "quantity" keys for ImagingPlane.origin_coords and ImagingPlane.grid_spacing for schema language compliance.

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

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

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

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

- Add optional "reference" column in "electrodes" table
- 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.

- 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.
- 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.

- 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.
- Updated hdmf-common-schema to version 1.1.0 which includes:

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

Expand Down

0 comments on commit 62c7340

Please sign in to comment.