Skip to content

Commit 4943ff6

Browse files
committed
final documentation update, release v2.0
1 parent 81feef3 commit 4943ff6

8 files changed

Lines changed: 20 additions & 8 deletions

File tree

ChangeLog.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,10 @@ JSONlab ChangeLog (key features marked by *):
88

99
== JSONlab 2.0 (codename: Magnus Prime), FangQ <q.fang (at) neu.edu> ==
1010

11+
2020-06-13 [81feef3] skil no-op markers, update documentation
12+
2020-06-13 [4904155] jload load data to struct, test if loadbj input is buffer, update error msg
13+
2020-06-12 [c334799] change default workspace to caller for jload and jsave
14+
2020-06-10 [c883546] fix keeptype single integer bug
1115
2020-06-09*[ ] created `jdata` and `bjdata` python modules to share data with MATLAB
1216
2020-06-08*[cbde607] add savebj and loadbj to dedicate to loading and saving bjdata
1317
2020-06-08*[e2451e1] add unit testing script, fix issues found in the testing unit

Contents.m

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -375,7 +375,7 @@
375375
% or
376376
% data=loadbj(fname,'param1',value1,'param2',value2,...)
377377
%
378-
% Parse a Binary JData (BJData, Draft-1, defined in https://github.com/OpenJData/bjdata)
378+
% Parse a Binary JData (BJData v1 Draft-1, defined in https://github.com/OpenJData/bjdata)
379379
% file or memory buffer and convert into a MATLAB data structure
380380
%
381381
% initially created on 2013/08/01
@@ -436,7 +436,7 @@
436436
% bjd=savebj(rootname,obj,'param1',value1,'param2',value2,...)
437437
%
438438
% Convert a MATLAB object (cell, struct, array, table, map, handles ...)
439-
% into a Binary JData (BJData, Draft 1), Universal Binary JSON (UBJSON,
439+
% into a Binary JData (BJData v1 Draft-1), Universal Binary JSON (UBJSON,
440440
% Draft-12) or a MessagePack binary stream
441441
%
442442
% initially created on 2013/08/17

README.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,10 @@ release v1.9.8 in Oct. 2019. A list of the major changes are summarized below
3232
efficiently encode special matrices and the addition of ``jsave/jload`` to save
3333
and restore variables in MATLAB/Octave like the ``save/load`` commands (experimental):
3434
35+
- 2020-06-13 [81feef3] skil no-op markers, update documentation
36+
- 2020-06-13 [4904155] jload load data to struct, test if loadbj input is buffer, update error msg
37+
- 2020-06-12 [c334799] change default workspace to caller for jload and jsave
38+
- 2020-06-10 [c883546] fix keeptype single integer bug
3539
- 2020-06-09*[ ] created ``jdata`` and ``bjdata`` python modules to share data with MATLAB
3640
- 2020-06-08*[cbde607] add savebj and loadbj to dedicate to loading and saving bjdata
3741
- 2020-06-08*[e2451e1] add unit testing script, fix issues found in the testing unit
@@ -78,7 +82,7 @@ and can be readily opened among a long list of programming environments
7882
such as Python, JavaScript and Go.
7983

8084
The ``saveubjson/loadubjson`` functions added support to the Binary JData specification (BJData)
81-
Draft 1 (https://github.com/fangq/bjdata) and are now renamed as ``savebj/loadbj``
85+
v1 Draft-1 (https://github.com/fangq/bjdata) and are now renamed as ``savebj/loadbj``
8286
(``saveubjson/loadubjson`` are kept for compatibility purposes as aliases to the new
8387
functions). The BJData spec is largely compatible with UBJSON spec Draft 12, with the
8488
following differences (we are working with the UBJSON maintainer to merge

README.txt

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,10 @@ release v1.9.8 in Oct. 2019. A list of the major changes are summarized below
3737
efficiently encode special matrices and the addition of `jsave/jload` to save
3838
and restore variables in MATLAB/Octave like the `save/load` commands (experimental):
3939

40+
* 2020-06-13 [81feef3] skil no-op markers, update documentation
41+
* 2020-06-13 [4904155] jload load data to struct, test if loadbj input is buffer, update error msg
42+
* 2020-06-12 [c334799] change default workspace to caller for jload and jsave
43+
* 2020-06-10 [c883546] fix keeptype single integer bug
4044
* 2020-06-09*[ ] created `jdata` and `bjdata` python modules to share data with MATLAB
4145
* 2020-06-08*[cbde607] add savebj and loadbj to dedicate to loading and saving bjdata
4246
* 2020-06-08*[e2451e1] add unit testing script, fix issues found in the testing unit
@@ -83,7 +87,7 @@ and can be readily opened among a long list of programming environments
8387
such as Python, JavaScript and Go.
8488

8589
The `saveubjson/loadubjson` functions added support to the Binary JData specification (BJData)
86-
Draft 1 (https://github.com/fangq/bjdata) and are now renamed as `savebj/loadbj`
90+
v1 Draft-1 (https://github.com/fangq/bjdata) and are now renamed as `savebj/loadbj`
8791
(`saveubjson/loadubjson` are kept for compatibility purposes as aliases to the new
8892
functions). The BJData spec is largely compatible with UBJSON spec Draft 12, with the
8993
following differences (we are working with the UBJSON maintainer to merge

loadbj.m

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
% or
55
% data=loadbj(fname,'param1',value1,'param2',value2,...)
66
%
7-
% Parse a Binary JData (BJData, Draft-1, defined in https://github.com/OpenJData/bjdata)
7+
% Parse a Binary JData (BJData v1 Draft-1, defined in https://github.com/OpenJData/bjdata)
88
% file or memory buffer and convert into a MATLAB data structure
99
%
1010
% authors:Qianqian Fang (q.fang <at> neu.edu)

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
"example": "examples"
77
},
88
"scripts": {
9-
"test": "echo \"Error: no test specified\" && exit 1"
9+
"test": "test/run_jsonlab_test.m"
1010
},
1111
"repository": {
1212
"type": "git",

savebj.m

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
% bjd=savebj(rootname,obj,'param1',value1,'param2',value2,...)
88
%
99
% Convert a MATLAB object (cell, struct, array, table, map, handles ...)
10-
% into a Binary JData (BJData, Draft 1), Universal Binary JSON (UBJSON,
10+
% into a Binary JData (BJData v1 Draft-1), Universal Binary JSON (UBJSON,
1111
% Draft-12) or a MessagePack binary stream
1212
%
1313
% author: Qianqian Fang (q.fang <at> neu.edu)

test/test_jsonlab.m

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
function run_jsonlab_test(testname,fhandle,input,expected,varargin)
1+
function test_jsonlab(testname,fhandle,input,expected,varargin)
22
res=fhandle('',input,varargin{:});
33
if(~isequal(strtrim(res),expected))
44
warning('Test %s: failed: expected ''%s'', obtained ''%s''',testname,expected,res);

0 commit comments

Comments
 (0)