Skip to content

docs: correct the dtype mapping reference for int/uint #878

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

Open
ehennestad wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: correct the dtype mapping reference for int/uint #878

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 7 additions & 2 deletions +spec/getBasicDTypeMap.m
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,13 @@
function mapping = getBasicDTypeMap()
% getBasicDTypeMap - Map basic HDMF dtypes onto MATLAB types
%
% Reference:
% https://github.com/hdmf-dev/hdmf/blob/5.1.0/src/hdmf/spec/spec.py#L31-L48
% `int` and `uint` map to the 8-bit types per the HDMF Schema Language
% dtype table (https://hdmf-schema-language.readthedocs.io/en/latest/description.html#dtype),
% which redefined them from int32/uint32 to int8/uint8 in version 3.0
% (https://github.com/hdmf-dev/hdmf-schema-language/pull/38). As of this
% writing, HDMF's own `hdmf.spec.spec.DtypeHelper` has not been updated to
% match and still uses the pre-3.0 int32/uint32 meaning
% (https://github.com/hdmf-dev/hdmf-schema-language/issues/50).

try
mapping = dictionary();
Expand Down