Skip to content

Commit 7e63d0f

Browse files
committed
Update inline help
Signed-off-by: Dan S. Camper <[email protected]>
1 parent 366df95 commit 7e63d0f

File tree

2 files changed

+12
-17
lines changed

2 files changed

+12
-17
lines changed

package.lisp

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22

33
(uiop/package:define-package #:json2ecl
44
(:use #:cl)
5-
(:export :toplevel :*ui*))
5+
(:export :toplevel))

userio.lisp

+11-16
Original file line numberDiff line numberDiff line change
@@ -24,34 +24,29 @@
2424
(adopt:make-option 'string-type
2525
:result-key 'string-type
2626
:parameter "STRING-TYPE"
27-
:help (format nil "ECL datatype to use for strings; must be one of ~
27+
:help (format nil "ECL datatype to use for JSON strings; must be one of ~
2828
UTF8|STRING|VARSTRING; defaults to UTF8")
2929
:long "string-type"
3030
:short #\s
3131
:initial-value "UTF8"
3232
:reduce #'adopt:last))
3333

34+
(defparameter *option-group-output*
35+
(adopt:make-group 'output-options
36+
:title "Output Options"
37+
:help "These options affect how the ECL RECORD structures are created."
38+
:options (list *option-ecl-string-type*)))
39+
3440
(adopt:define-string *help-text*
3541
"json2ecl examines JSON data and deduces the ECL RECORD definitions necessary to parse it. ~
36-
The resulting ECL definitions are returned via standard out, suitable for piping or copying ~
37-
and pasting into your favorite IDE.~@
42+
The resulting ECL definitions are returned via standard out, suitable for piping or pasting ~
43+
into your favorite IDE.~@
3844
~@
3945
JSON data can be supplied as one or more files or via standard input.~@
4046
~@
4147
Multiple files, if provided, are parsed as if they should have the same record structure. ~
4248
This is useful for cases where you suspect that not all JSON key/value objects are fully ~
43-
defined in one file, but other files may contain the missing data.~@
44-
~@
45-
The `-h` and `-v` versions should be obvious.~@
46-
~@
47-
The -s option allows you to override the ECL datatype used for string values. ~
48-
Because JSON data is normally in UTF-8 format, UTF8 is the default ECL data type for ~
49-
those values. However, if you know that the data is in plain ASCII then you can override ~
50-
the type with this option. The acceptable values are:~@
51-
~@
52-
- UTF8: A UTF-8 string; this is the default.~@
53-
- STRING: An ASCII string.~@
54-
- VARSTRING: A C-style null-terminated string. Don't use this unless you know why you need it.")
49+
defined in one file, and other files may contain the missing data.")
5550

5651
(defparameter *ui*
5752
(adopt:make-interface :name "json2ecl"
@@ -62,7 +57,7 @@ the type with this option. The acceptable values are:~@
6257
:contents (list
6358
*option-version*
6459
*option-help*
65-
*option-ecl-string-type*)))
60+
*option-group-output*)))
6661

6762
;;;
6863

0 commit comments

Comments
 (0)