Commits

camlspotter committed 6329b27 Draft

comment fix

  • Participants
  • Parent commits a3ba865

Comments (0)

Files changed (1)

File README.custom.rst

 is introduced for OCaml record fields and constructors which start 
 with "caml_" and "CAML_" respectively::
 
-  type t = CAML_text with json (\* in Json, not "CAML_text" but "text" \*)
+  type t = Foo | CAML_text with json (\* in Json, not "CAML_text" but "text" \*)
 
   type r = { caml_type : t } with json (\* in Json, not "caml_type" but "type" \*)
 
 ==========================================
 
 Data type name "optional" in OCaml record field type is specially handled. 
-It works as the option type, but the field can be really optional. The field
-need not to exist in Json fields at Json => OCaml translation.
+It works as the option type, but the field can be optional: it needs not to exist 
+in Json fields at Json=>OCaml translation.
 
-  type 'a optional = 'a option (\* You need to declare this alias \*)
+  type 'a optional = 'a option (\* You need to declare this alias by yourself \*)
 
   type r = { id : Id.t;  (\* mandatory field \*)
              source_url : string optional; (\* if not exists in Json, None in OCaml \*)
            } with json
 
-  CR jfuruse: No OCaml => Json handling of optional is considered yet.
+  CR jfuruse: OCaml=>Json handling of optional field is not considered yet.