Skip to content

Commit 8eb3959

Browse files
authored
Update README.rst
1 parent fee91ff commit 8eb3959

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

README.rst

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -372,12 +372,12 @@ saveubjson.m
372372
examples
373373
---------
374374

375-
Under the "examples" folder, you can find several scripts to demonstrate the
376-
basic utilities of JSONLab. Running the "demo_jsonlab_basic.m" script, you
375+
Under the ``"examples"`` folder, you can find several scripts to demonstrate the
376+
basic utilities of JSONLab. Running the ``"demo_jsonlab_basic.m"`` script, you
377377
will see the conversions from MATLAB data structure to JSON text and backward.
378-
In "jsonlab_selftest.m", we load complex JSON files downloaded from the Internet
379-
and validate the loadjson/savejson functions for regression testing purposes.
380-
Similarly, a "demo_ubjson_basic.m" script is provided to test the saveubjson
378+
In ``"jsonlab_selftest.m"``, we load complex JSON files downloaded from the Internet
379+
and validate the ``loadjson/savejson`` functions for regression testing purposes.
380+
Similarly, a ``"demo_ubjson_basic.m"`` script is provided to test the saveubjson
381381
and loadubjson functions for various matlab data structures.
382382

383383
Please run these examples and understand how JSONLab works before you use
@@ -392,17 +392,17 @@ and robust. Hopefully in a few future releases, the limitations become less.
392392

393393
Here are the known issues:
394394

395-
# 3D or higher dimensional cell/struct-arrays will be converted to 2D arrays;
396-
# When processing names containing multi-byte characters, Octave and MATLAB \
397-
can give different field-names; you can use feature('DefaultCharacterSet','latin1') \
398-
in MATLAB to get consistant results
399-
# savejson can not handle class and dataset.
400-
# saveubjson converts a logical array into a uint8 ([U]) array
401-
# an unofficial N-D array count syntax is implemented in saveubjson. We are \
402-
actively communicating with the UBJSON spec maintainer to investigate the \
403-
possibility of making it upstream
404-
# loadubjson can not parse all UBJSON Specification (Draft 9) compliant \
405-
files, however, it can parse all UBJSON files produced by saveubjson.
395+
* 3D or higher dimensional cell/struct-arrays will be converted to 2D arrays
396+
397+
* When processing names containing multi-byte characters, Octave and MATLAB can give different field-names; you can use feature('DefaultCharacterSet','latin1') in MATLAB to get consistant results
398+
399+
* savejson can not handle class and dataset.
400+
401+
* saveubjson converts a logical array into a uint8 ([U]) array
402+
403+
* an unofficial N-D array count syntax is implemented in saveubjson. We are actively communicating with the UBJSON spec maintainer to investigate the possibility of making it upstream
404+
405+
* loadubjson can not parse all UBJSON Specification (Draft 9) compliant files, however, it can parse all UBJSON files produced by saveubjson.
406406

407407
==========================
408408
Contribution and feedback
@@ -454,6 +454,6 @@ the changes and commit it to the subversion if they are satisfactory.
454454
We appreciate any suggestions and feedbacks from you. Please use the following
455455
mailing list to report any questions you may have regarding JSONLab:
456456

457-
https://groups.google.com/forum/?hl=en#!forum/jsonlab-users
457+
`forum/jsonlab-users <https://groups.google.com/forum/?hl=en#>`_
458458

459459
(Subscription to the mailing list is needed in order to post messages).

0 commit comments

Comments
 (0)