Skip to content

Commit ade1d55

Browse files
committed
Update CLI docs to match new docstrings.
1 parent 1fff4f2 commit ade1d55

File tree

3 files changed

+60
-45
lines changed

3 files changed

+60
-45
lines changed

docs/source/cli/camel_arclean.rst

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,9 @@ Below is the usage information that can be generated by running
2727
camel_arclean (-h | --help)
2828
2929
Options:
30-
-o OUTPUT --output=OUTPUT Output file. If not specified, output will be
31-
printed to stdout.
32-
-h --help Show this screen.
33-
-v --version Show version.
30+
-o OUTPUT --output=OUTPUT
31+
Output file. If not specified, output will be printed to stdout.
32+
-h --help
33+
Show this screen.
34+
-v --version
35+
Show version.

docs/source/cli/camel_calima_star.rst

Lines changed: 37 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -17,39 +17,45 @@ Below is the usage information that can be generated by running
1717
.. code-block:: none
1818
1919
Usage:
20-
camel_calima_star analyze
21-
[-d DATABASE | --db=DATABASE]
22-
[-b BACKOFF | --backoff BACKOFF]
23-
[-c | --cache]
24-
[-o OUTPUT | --output=OUTPUT] [FILE]
25-
camel_calima_star generate
26-
[-d DATABASE | --db=DATABASE]
27-
[-b BACKOFF | --backoff BACKOFF]
28-
[-o OUTPUT | --output=OUTPUT] [FILE]
29-
camel_calima_star reinflect
30-
[-d DATABASE | --db=DATABASE]
31-
[-o OUTPUT | --output=OUTPUT] [FILE]
32-
camel_calima_star (-l | --list)
33-
camel_calima_star (-v | --version)
34-
camel_calima_star (-h | --help)
20+
camel_calima_star analyze
21+
[-D DISAMBIG | --disambig=DISAMBIG]
22+
[-d DATABASE | --db=DATABASE]
23+
[-b BACKOFF | --backoff=BACKOFF]
24+
[-c | --cache]
25+
[-o OUTPUT | --output=OUTPUT] [FILE]
26+
camel_calima_star generate
27+
[-d DATABASE | --db=DATABASE]
28+
[-b BACKOFF | --backoff=BACKOFF]
29+
[-o OUTPUT | --output=OUTPUT] [FILE]
30+
camel_calima_star reinflect
31+
[-d DATABASE | --db=DATABASE]
32+
[-o OUTPUT | --output=OUTPUT] [FILE]
33+
camel_calima_star (-l | --list)
34+
camel_calima_star (-v | --version)
35+
camel_calima_star (-h | --help)
3536
3637
Options:
37-
-b BACKOFF --backoff BACKOFF Backoff mode for analyzer and generator. In
38-
analyze mode, it can have the following
39-
values: NONE, NOAN_ALL, NOAN_PROP, ADD_ALL,
40-
ADD_PROP. In generate mode it can have the
41-
following values: NONE, REINFLECT. Defaults to
42-
NONE if not specified.
43-
-c --cache Cache computed analyses (only in analyze mode).
44-
-d DATABASE --db=DATABASE CalimaStar database to use. DATABASE could be
45-
the name of a builtin database or a path to a
46-
database file [default: almor-msa].
47-
-o OUTPUT --output=OUTPUT Output file. If not specified, output will be
48-
printed to stdout.
49-
-l --list List builtin databases with their respective
50-
versions.
51-
-h --help Show this screen.
52-
-v --version Show version.
38+
-b BACKOFF --backoff=BACKOFF
39+
Backoff mode for analyzer and generator. In analyze mode, it can have
40+
the following values: NONE, NOAN_ALL, NOAN_PROP, ADD_ALL, ADD_PROP.
41+
In generate mode it can have the following values: NONE, REINFLECT.
42+
[default: NONE]
43+
-c --cache
44+
Cache computed analyses (only in analyze mode).
45+
-D DISAMBIG --disambig=DISAMBIG
46+
Disambiguate analyses using pos-lex frequency showing only the top
47+
DISAMBIG analyses. DISAMBIG should be non-zero positive integer.
48+
-d DATABASE --db=DATABASE
49+
CalimaStar database to use. DATABASE could be the name of a builtin
50+
database or a path to a database file. [default: almor-msa]
51+
-o OUTPUT --output=OUTPUT
52+
Output file. If not specified, output will be printed to stdout.
53+
-l --list
54+
List builtin databases with their respective versions.
55+
-h --help
56+
Show this screen.
57+
-v --version
58+
Show version.
5359
5460
Analyze Mode
5561
------------

docs/source/cli/camel_transliterate.rst

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -28,16 +28,23 @@ Below is the usage information that can be generated by running
2828
camel_transliterate (-h | --help)
2929
3030
Options:
31-
-s SCHEME --scheme Scheme used for transliteration.
32-
-o OUTPUT --output=OUTPUT Output file. If not specified, output will be
33-
printed to stdout.
34-
-m MARKER --marker=MARKER Marker used to prefix tokens not to be
35-
transliterated. Set to '@@IGNORE@@' by default.
36-
-I --ignore-markers Transliterate marked words as well.
37-
-S --strip-markers Remove markers in output.
38-
-l --list Show a list of available transliteration schemes.
39-
-h --help Show this screen.
40-
-v --version Show version.
31+
-s SCHEME --scheme
32+
Scheme used for transliteration.
33+
-o OUTPUT --output=OUTPUT
34+
Output file. If not specified, output will be printed to stdout.
35+
-m MARKER --marker=MARKER
36+
Marker used to prefix tokens not to be transliterated.
37+
[deafualt: @@IGNORE@@]
38+
-I --ignore-markers
39+
Transliterate marked words as well.
40+
-S --strip-markers
41+
Remove markers in output.
42+
-l --list
43+
Show a list of available transliteration schemes.
44+
-h --help
45+
Show this screen.
46+
-v --version
47+
Show version.
4148
4249
Below is a list of currently available transliteration schemes.
4350

0 commit comments

Comments
 (0)