docs: correct the dtype mapping reference for int/uint - #878
Open
ehennestad wants to merge 1 commit into
Open
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #878 +/- ##
=======================================
Coverage 95.27% 95.27%
=======================================
Files 234 234
Lines 8311 8311
=======================================
Hits 7918 7918
Misses 393 393 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
ehennestad
force-pushed
the
fix-uint-dtype-map-citation
branch
from
August 27, 2026 16:06
2d40999 to
39b6bff
Compare
ehennestad
enabled auto-merge
August 27, 2026 16:06
The comment cited HDMF's spec.py as the source for mapping `int`/`uint` to the 8-bit MATLAB types, but spec.py still uses the pre-3.0 meaning (int32/uint32). The 8-bit meaning comes from HDMF Schema Language 3.0 (hdmf-schema-language#38), which HDMF has not yet adopted (hdmf-schema-language#50). Point the comment at the schema language docs instead and note the discrepancy. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
ehennestad
force-pushed
the
fix-uint-dtype-map-citation
branch
from
August 31, 2026 10:44
39b6bff to
b3e5958
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation
Problem —
spec.getBasicDTypeMapmaps the schema dtypesintanduinttoint8anduint8, and cites HDMF'shdmf.spec.specas the reference for that mapping. Those two entries do not appear there: HDMF still treatsintanduintas the 32-bit types. A developer checking the file against its own citation finds a contradiction and cannot tell which side is correct.Solution — Cite the source the values actually come from. The 8-bit meaning was introduced by HDMF Schema Language 3.0, which HDMF has not adopted yet, so name that and note the discrepancy rather than leaving it to be rediscovered.
What changed
spec.getBasicDTypeMappoints at the HDMF Schema Language dtype table and the change that introduced the 8-bit meaning, and records that HDMF still uses the pre-3.0 meaning.No mapping values change, so there is no behavioural difference and nothing to regenerate.
Background
dtype: intfromint32toint8", withdtype: uintmeaninguint8. Before 3.0,intwas synonymous withint32anduintwas not listed.DtypeHelper.primary_dtype_synonymsstill mapsinttoint32anduinttouint32, which is what the old citation pointed at.Examples
Comment-only change, so there is no before/after behaviour to show. The mapping is unchanged:
How to test
Checklist
fix #XXwhereXXis the issue number?🤖 Generated with Claude Code