Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docs on spec language support #1069

Merged
merged 5 commits into from
Mar 12, 2024
Merged

Add docs on spec language support #1069

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
5677493
Add docs on spec language support
rly Mar 12, 2024
b3b5a0b
Add changelog and index entry
rly Mar 12, 2024
64041bc
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Mar 12, 2024
dff4d87
Update changelog
rly Mar 12, 2024
3b30717
Fixes
rly Mar 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
Loading