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.

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

Change "int" meaning to "int8", reorder table #38

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
27 changes: 16 additions & 11 deletions source/description.rst
Original file line number Diff line number Diff line change
Expand Up @@ -552,22 +552,22 @@ String specifying the data type of the attribute. Allowable values are:
+--------------------------+----------------------------------+----------------+
| ``dtype`` **spec value** | **storage type** | **size** |
+--------------------------+----------------------------------+----------------+
| * "float" | single precision floating point | 32 bit |
| * "float32" | | |
| * "float64" | double precision floating point | 64 bit |
| * "double" | | |
+--------------------------+----------------------------------+----------------+
| * "double" | double precision floating point | 64 bit |
| * "float64" | | |
| * "float32" | single precision floating point | 32 bit |
| * "float" | | |
+--------------------------+----------------------------------+----------------+
| * "long" | signed 64 bit integer | 64 bit |
| * "int64" | | |
| * "int64" | signed 64 bit integer | 64 bit |
| * "long" | | |
+--------------------------+----------------------------------+----------------+
| * "int" | signed 32 bit integer | 32 bit |
| * "int32" | | |
| * "int32" | signed 32 bit integer | 32 bit |
+--------------------------+----------------------------------+----------------+
| * "short" | signed 16 bit integer | 16 bit |
| * "int16" | | |
| * "int16" | signed 16 bit integer | 16 bit |
| * "short" | | |
+--------------------------+----------------------------------+----------------+
| * "int8" | signed 8 bit integer | 8 bit |
| * "int" | | |
+--------------------------+----------------------------------+----------------+
| * "uint64" | unsigned 64 bit integer | 64 bit |
+--------------------------+----------------------------------+----------------+
Expand All @@ -576,6 +576,7 @@ String specifying the data type of the attribute. Allowable values are:
| * "uint16" | unsigned 16 bit integer | 16 bit |
+--------------------------+----------------------------------+----------------+
| * "uint8" | unsigned 8 bit integer | 8 bit |
| * "uint" | | |
+--------------------------+----------------------------------+----------------+
| * "numeric" | any numeric type (i.e., any int, | 8 to 64 bit |
| | uint, float) | |
Expand All @@ -600,11 +601,15 @@ String specifying the data type of the attribute. Allowable values are:

.. note::

The precision indicated in the specification is interpreted as a minimum precision.
The precision indicated in the specification is interpreted as a **minimum** precision.
Higher precisions may be used if required by the particular data.
In addition, since valid ASCII text is valid UTF-8-encoded Unicode, ASCII text may be used
where 8-bit Unicode is required. 8-bit Unicode cannot be used where ASCII is required.

.. note::

Prior to version 3.0, ``int`` was synonymous with ``int32``, and ``uint`` was not listed.

Reference ``dtype``
"""""""""""""""""""

Expand Down
13 changes: 7 additions & 6 deletions source/hdmf.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -87,21 +87,22 @@
{
"type": "string",
"enum": [
"float",
"float32",
"double",
"float64",
"long",
"double",
"float32",
"float",
"int64",
"int",
"long",
"int32",
"int16",
"short",
"int8",
"uint",
"int",
"uint64",
"uint32",
"uint16",
"uint8",
"uint",
"numeric",
"text",
"utf",
Expand Down
1 change: 1 addition & 0 deletions source/release_notes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ Version 3.0.0 (Upcoming)
* Updated ``datetime`` specification to allow a date with no time or timezone.
* Changed the meaning of the default shape ``shape: null`` from representing a scalar to representing any shape.
* Added special value for ``shape: scalar`` that represents a scalar.
* Changed the meaning of ``dtype: int`` from int32 to int8. Added ``dtype: uint`` which means uint8.

Version 2.0.2 (March, 2020)
---------------------------------
Expand Down