diff --git a/CHANGELOG.md b/CHANGELOG.md index 1294aee02..cd7b69fcb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,10 @@ # HDMF Changelog +## HDMF 3.13.0 (Upcoming) + +### Enhancements +- Added docs page that lists limitations of support for the HDMF specification language. @rly [#1069](https://github.com/hdmf-dev/hdmf/pull/1069) + ## HDMF 3.12.2 (February 9, 2024) ### Bug fixes diff --git a/docs/source/index.rst b/docs/source/index.rst index e6a53d3ab..2fcd4778a 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -45,6 +45,7 @@ If you use HDMF in your research, please use the following citation: building_api export validation + spec_language_support .. toctree:: :hidden: diff --git a/docs/source/spec_language_support.rst b/docs/source/spec_language_support.rst new file mode 100644 index 000000000..43a628093 --- /dev/null +++ b/docs/source/spec_language_support.rst @@ -0,0 +1,21 @@ + +.. _spec_language_support: + +=========================================== +Support for the HDMF Specification Language +=========================================== + +The HDMF API provides nearly full support for all features of the `HDMF Specification Language`_ +version 3.0.0, except for the following: + +1. Attributes containing multiple references (see `#833`_) +2. Certain text and integer values for quantity (see `#423`_, `#531`_) +3. Datasets that do not have a data_type_inc/data_type_def and contain either a reference dtype or a compound dtype (see `#737`_) +4. Passing dataset dtype and shape from parent data type to child data type (see `#320`_) + +.. _HDMF Specification Language: https://hdmf-schema-language.readthedocs.io +.. _#833: https://github.com/hdmf-dev/hdmf/issues/833 +.. _#423: https://github.com/hdmf-dev/hdmf/issues/423 +.. _#531: https://github.com/hdmf-dev/hdmf/issues/531 +.. _#737: https://github.com/hdmf-dev/hdmf/issues/737 +.. _#320: https://github.com/hdmf-dev/hdmf/issues/320