From 5677493a3a24de1a7599d103de0d6ce6275ee69e Mon Sep 17 00:00:00 2001 From: Ryan Ly Date: Tue, 12 Mar 2024 17:57:35 +0000 Subject: [PATCH 1/5] Add docs on spec language support --- docs/source/spec_language_support.rst | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 docs/source/spec_language_support.rst diff --git a/docs/source/spec_language_support.rst b/docs/source/spec_language_support.rst new file mode 100644 index 000000000..757578bc5 --- /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 Specificiation 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 Specificiation Language: https://hdmf-schema-language.readthedocs.io/en/latest/>` +.. _#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 From b3b5a0b12490f456428be5bc4ccd6c3fcfe22424 Mon Sep 17 00:00:00 2001 From: Ryan Ly Date: Tue, 12 Mar 2024 17:59:55 +0000 Subject: [PATCH 2/5] Add changelog and index entry --- CHANGELOG.md | 5 +++++ docs/source/index.rst | 1 + 2 files changed, 6 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 1294aee02..00ccd0c2a 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 + ## 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: From 64041bc5b118f6131ad60628482d2f4c8351f939 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Tue, 12 Mar 2024 18:00:29 +0000 Subject: [PATCH 3/5] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 00ccd0c2a..96db89a4d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,7 +3,7 @@ ## HDMF 3.13.0 (Upcoming) ### Enhancements -- Added docs page that lists limitations of support for the HDMF specification language. @rly +- Added docs page that lists limitations of support for the HDMF specification language. @rly ## HDMF 3.12.2 (February 9, 2024) From dff4d8730f9498871fd58ac4b32244a8ed867f3d Mon Sep 17 00:00:00 2001 From: Ryan Ly Date: Tue, 12 Mar 2024 18:01:36 +0000 Subject: [PATCH 4/5] Update changelog --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 96db89a4d..cd7b69fcb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,7 +3,7 @@ ## HDMF 3.13.0 (Upcoming) ### Enhancements -- Added docs page that lists limitations of support for the HDMF specification language. @rly +- 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) From 3b3071709db7f2caea4e3d4cddfa54f32ae354c5 Mon Sep 17 00:00:00 2001 From: Ryan Ly Date: Tue, 12 Mar 2024 18:10:29 +0000 Subject: [PATCH 5/5] Fixes --- docs/source/spec_language_support.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/spec_language_support.rst b/docs/source/spec_language_support.rst index 757578bc5..43a628093 100644 --- a/docs/source/spec_language_support.rst +++ b/docs/source/spec_language_support.rst @@ -5,7 +5,7 @@ Support for the HDMF Specification Language =========================================== -The HDMF API provides nearly full support for all features of the `HDMF Specificiation 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`_) @@ -13,7 +13,7 @@ version 3.0.0, except for the following: 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 Specificiation Language: https://hdmf-schema-language.readthedocs.io/en/latest/>` +.. _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