From 6c1e2f641fca7561d63a5aba782aafd32c4e3788 Mon Sep 17 00:00:00 2001 From: Qianqian Fang Date: Thu, 12 May 2022 00:04:18 -0400 Subject: [PATCH] Add info on demoting ND array to a 1-D optimized array when singleton dimension --- docs/mkdocs/docs/features/binary_formats/bjdata.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/mkdocs/docs/features/binary_formats/bjdata.md b/docs/mkdocs/docs/features/binary_formats/bjdata.md index b7473cf63..fae55658f 100644 --- a/docs/mkdocs/docs/features/binary_formats/bjdata.md +++ b/docs/mkdocs/docs/features/binary_formats/bjdata.md @@ -126,7 +126,9 @@ The library uses the following mapping from JSON values types to BJData types ac In the reversed direction, when `to_bjdata` detects a JSON object in the above form, it automatically converts such object into a BJData ND-array - to generate compact output. + to generate compact output. The only exception is that when the 1-D dimensional + vector stored in `"_ArraySize_"` contains a single integer, or two integers with + one being 1, a regular 1-D optimized array is generated. The current version of this library has not yet supported automatic recognition and conversion from a nested JSON array input to a BJData ND-array.