Skip to content

Commit 32813fc

Browse files
committed
Merge pull request #2 from flpa/readme-typos
Minor changes and fixes in README
2 parents 29b8f86 + fb16ec8 commit 32813fc

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

Diff for: README

+12-12
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ getopt - An imitation of the Unix 'getopt' command line program
6666
handled by the calling program more easily.
6767

6868
Cli-options can be any list of strings. Each string
69-
begging with a single '-' is interpreted as a series of
69+
beginning with a single '-' is interpreted as a series of
7070
short options and any beginning with '--' is interpreted
7171
as a long option. Others are either free tokens or
7272
parameters. Any tokens appearing after a token that is
@@ -153,11 +153,11 @@ with-cli-options - A macro that binds values passed in from the command
153153
formed.
154154

155155
In addition, symbols in option-variables are boolean by
156-
default; that is, they bound to either t or nil depending on
157-
whether they are passed in on the cli. Symbols listed after
158-
&parameters, if it is present, are are considered parameter
159-
options, that is, they are bound to the next token on the cli
160-
if the are long options or the same or the rest of the
156+
default; that is, they are bound to either t or nil depending on
157+
whether they are passed in on the CLI. Symbols listed after
158+
&parameters, if it is present, are considered parameter
159+
options, that is, they are bound to the next token on the CLI
160+
if they are long options or the same or the rest of the
161161
current short option group, if they are short options. If
162162
nothing is passed for this options (ie. if it is the last
163163
token) it is bound to nil.
@@ -171,7 +171,7 @@ with-cli-options - A macro that binds values passed in from the command
171171
able to print out a usage summary (using print-usage-summary)
172172
based on the options bound in option-varibles. The summary
173173
will be printed either when an invalid option is specified or
174-
the user uses '-h' or '--help' as an option. If
174+
when the user uses '-h' or '--help' as an option. If
175175
enable-usage-summary is set to a string, that string is passed
176176
as control string to print-usage-summary. Else, a generic
177177
string is used.
@@ -195,11 +195,11 @@ print-usage-summary - Prints a usage description of the current program
195195

196196
prototype: (print-usage-summary description option-specs)
197197

198-
details: Print-usage-summary print a usage summary of options specified
198+
details: Print-usage-summary prints a summary of options specified
199199
by options-specs.
200200

201201
The function takes each option-spec and generates a string
202-
describing in detail each option. The resulting strings are
202+
describing each option in detail. The resulting strings are
203203
passed as arguments to a call to format. Description is used
204204
as the control string. The option-spec descriptions are auto-
205205
aligned.
@@ -216,15 +216,15 @@ print-usage-summary - Prints a usage description of the current program
216216
end summary
217217
=>NIL
218218

219-
map-parsed-options - Function that does the actual parsing of cli tokens
219+
map-parsed-options - Function that does the actual parsing of CLI tokens
220220

221221
prototype: (map-parsed-options cli-options bool-options param-options
222222
opt-val-func free-val-func)
223223

224224
details: Map-parsed-options is the backend function that does most
225-
of the actual work in parsing cli functions. It is exposed
225+
of the actual work in parsing CLI functions. It is exposed
226226
to allow more front ends in addition to getopt and
227-
with-cli-options. Map-parsed-options receives a list of cli
227+
with-cli-options. Map-parsed-options receives a list of CLI
228228
tokens, as well as two list of options, boolean options and
229229
options with parameters, respectively. The final two
230230
arguments are functions, one to handle found options and

0 commit comments

Comments
 (0)