Skip to content

Commit

Permalink
Add docs on spec language support (#1069)
Browse files Browse the repository at this point in the history
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
  • Loading branch information
rly and pre-commit-ci[bot] committed Mar 12, 2024
1 parent 048b9b8 commit e9c2737
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 0 deletions.
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
1 change: 1 addition & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
21 changes: 21 additions & 0 deletions docs/source/spec_language_support.rst
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit e9c2737

Please sign in to comment.