Skip to content

Commit

Permalink
update releasenotes
Browse files Browse the repository at this point in the history
  • Loading branch information
gbeckers committed May 16, 2022
1 parent 0e58077 commit a2187bf
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 2 deletions.
15 changes: 15 additions & 0 deletions docs/design.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
Format Design
=============

Binary array data and text metadata in separate files
-----------------------------------------------------

- The numeric array is saved in a flat binary file called 'arrayvalues.bin'.
- Information on the array's shape, type, memory layout and byte order is
stored in a JSON text file called 'arraydescription.json'.
- Metadata is stored in a JSON text file called 'metadata.json'.
- Human-readable documentation, with full format descriptions and code
snippets to ready the array data in many language are stored in a UTF-8
text file called 'README.txt'.
- These four files are stored in a separate directory, which represents the
Darr array.
4 changes: 2 additions & 2 deletions docs/releasenotes.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
Release notes
=============

Master
------
Version 0.5.1
-------------
- automatically convert numpy datetime64 to str in json metadata

Version 0.5.0
Expand Down

0 comments on commit a2187bf

Please sign in to comment.