Till Westmann has posted comments on this change.

Change subject: Add the documentation for the `binary` data type
......................................................................


Patch Set 1:

(5 comments)

https://asterix-gerrit.ics.uci.edu/#/c/934/1/asterixdb/asterix-doc/src/site/markdown/aql/datamodel.md
File asterixdb/asterix-doc/src/site/markdown/aql/datamodel.md:

Line 129: The total length of the sequence can be up to 2,147,483,648.
It seems to me that know about the maximal length is useful for an AQL user, 
but the implementation details are not really relevant (and we should be able 
to change those without modifying the semantics of the data type.


Line 161:         "base64_2": hex("41737465726978") }
The documentation looks good to me but, again, I would not talk about the 
internal representation.


https://asterix-gerrit.ics.uci.edu/#/c/934/1/asterixdb/asterix-doc/src/site/markdown/aql/functions.md
File asterixdb/asterix-doc/src/site/markdown/aql/functions.md:

Line 598:       parse-binary(string, encoded_type)  
WS


Line 603:     * `encoded_type` : A string notation specifies the encoding type 
of the given `string`. Currently we support `hex` and `base64` format.
Could we put a line-break here to stick to 120 chars?


Line 626:     * `encoding_type` : A string notation specifies the expected 
encoding type. Currently we support `hex` and `base64` format.
Could we put a line-break here to stick to 120 chars?

Also, should we just call the "encoded_type" and "encoding_type" parameters 
"encoding"? I think that people will understand it and it'd be a bit shorter 
and consistent between the functions.


-- 
To view, visit https://asterix-gerrit.ics.uci.edu/934
To unsubscribe, visit https://asterix-gerrit.ics.uci.edu/settings

Gerrit-MessageType: comment
Gerrit-Change-Id: Iea9b29a1a8ff37617fb94cd562a1f885f8867ad3
Gerrit-PatchSet: 1
Gerrit-Project: asterixdb
Gerrit-Branch: master
Gerrit-Owner: Jianfeng Jia <jianfeng....@gmail.com>
Gerrit-Reviewer: Jenkins <jenk...@fulliautomatix.ics.uci.edu>
Gerrit-Reviewer: Michael Carey <dtab...@gmail.com>
Gerrit-Reviewer: Till Westmann <ti...@apache.org>
Gerrit-HasComments: Yes

Reply via email to