Skip to content

Commit 5168187

Browse files
committed
A few very minor grammar fixes
1 parent a711640 commit 5168187

File tree

3 files changed

+9
-9
lines changed

3 files changed

+9
-9
lines changed

docs/features/argument_processing.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -227,8 +227,8 @@ class CmdLineApp(cmd2.Cmd):
227227

228228
## Unknown Positional Arguments
229229

230-
To pass all unknown arguments to be passed to your command as a list of strings, then decorate the
231-
command method with the `@with_argparser(..., with_unknown_args=True)` decorator.
230+
To pass all unknown arguments to your command as a list of strings, then decorate the command method
231+
with the `@with_argparser(..., with_unknown_args=True)` decorator.
232232

233233
Here's what it looks like:
234234

docs/features/commands.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -73,34 +73,34 @@ already parsed.
7373

7474
A `Statement` object is a subclass of `str` that contains the following attributes:
7575

76-
command
76+
**command**
7777

7878
: Name of the command called. You already know this because of the method `cmd2` called, but it can
7979
sometimes be nice to have it in a string, i.e. if you want your error messages to contain the
8080
command name.
8181

82-
args
82+
**args**
8383

8484
: A string containing the arguments to the command with output redirection or piping to shell
8585
commands removed. It turns out that the "string" value of the `Statement` object has all the output
8686
redirection and piping clauses removed as well. Quotes remain in the string.
8787

88-
command_and_args
88+
**command_and_args**
8989

9090
: A string of just the command and the arguments, with output redirection or piping to shell
9191
commands removed.
9292

93-
argv
93+
**argv**
9494

9595
: A list of arguments a-la `sys.argv`, including the command as `argv[0]` and the subsequent
9696
arguments as additional items in the list. Quotes around arguments will be stripped as will any
9797
output redirection or piping portions of the command.
9898

99-
raw
99+
**raw**
100100

101101
: Full input exactly as typed by the user.
102102

103-
terminator
103+
**terminator**
104104

105105
: Character used to end a multiline command. You can configure multiple termination characters, and
106106
this attribute will tell you which one the user typed.

docs/features/completion.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ an error occurs in which it is more desirable to display a message than a stack
8484
has a member called `apply_style`. Set this False if the error style should not be applied. For
8585
instance, `ArgparseCompleter` sets it to False when displaying completion hints.
8686

87-
## Tab Completion Using argparse Decorator {: #argparse-based }
87+
## Tab Completion Using the argparse Decorator {: #argparse-based }
8888

8989
When using `cmd2`'s [@with_argparser][cmd2.with_argparser] decorator, `cmd2` provides automatic tab
9090
completion of flag names.

0 commit comments

Comments
 (0)