Skip to content

Commit 187b8ec

Browse files
committed
Correcting grammar.
1 parent 8049aef commit 187b8ec

3 files changed

Lines changed: 4 additions & 4 deletions

File tree

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ prompt is displayed.
6464
before calling it like the previous functions did.
6565
- Removed `Cmd.default_to_shell`.
6666
- Removed `Cmd.ruler` since `cmd2` no longer uses it.
67-
- All parsers used with `cmd2` commands much be an instance of `Cmd2ArgumentParser` or a child
67+
- All parsers used with `cmd2` commands must be an instance of `Cmd2ArgumentParser` or a child
6868
class of it.
6969
- Removed `set_ap_completer_type()` and `get_ap_completer_type()` since `ap_completer_type` is
7070
now a public member of `Cmd2ArgumentParser`.

cmd2/decorators.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -226,7 +226,7 @@ def with_argparser(
226226
) -> Callable[[ArgparseCommandFunc[CmdOrSet]], RawCommandFuncOptionalBoolReturn[CmdOrSet]]:
227227
"""Decorate a ``do_*`` method to populate its ``args`` argument with the given instance of Cmd2ArgumentParser.
228228
229-
:param parser: instance of Cmd2ArgumentParser or a callable that returns an Cmd2ArgumentParser for this command
229+
:param parser: instance of Cmd2ArgumentParser or a callable that returns a Cmd2ArgumentParser for this command
230230
:param ns_provider: An optional function that accepts a cmd2.Cmd or cmd2.CommandSet object as an argument and returns an
231231
argparse.Namespace. This is useful if the Namespace needs to be prepopulated with state data that
232232
affects parsing.
@@ -362,7 +362,7 @@ def as_subcommand_to(
362362
363363
:param command: Command Name. Space-delimited subcommands may optionally be specified
364364
:param subcommand: Subcommand name
365-
:param parser: instance of Cmd2ArgumentParser or a callable that returns an Cmd2ArgumentParser for this subcommand
365+
:param parser: instance of Cmd2ArgumentParser or a callable that returns a Cmd2ArgumentParser for this subcommand
366366
:param help: Help message for this subcommand which displays in the list of subcommands of the command we are adding to.
367367
This is passed as the help argument to subparsers.add_parser().
368368
:param aliases: Alternative names for this subcommand. This is passed as the alias argument to

docs/migrating/next_steps.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ leveraging other `cmd2` features. The three ideas here will get you started. Bro
99
For all but the simplest of commands, it's probably easier to use
1010
[argparse](https://docs.python.org/3/library/argparse.html) to parse user input than to do it
1111
manually yourself for each command. `cmd2` provides a `@with_argparser()` decorator which associates
12-
an `Cmd2ArgumentParser` object with one of your commands. Using this method will:
12+
a `Cmd2ArgumentParser` object with one of your commands. Using this method will:
1313

1414
1. Pass your command a
1515
[Namespace](https://docs.python.org/3/library/argparse.html#argparse.Namespace) containing the

0 commit comments

Comments
 (0)