Skip to content

Commit 366c309

Browse files
committed
Updated docstring
1 parent c1cbbab commit 366c309

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

cmd2/cmd2.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -199,8 +199,8 @@ def with_argparser_and_unknown_args(argparser: argparse.ArgumentParser,
199199
instance of argparse.ArgumentParser, but also returning unknown args as a list.
200200
201201
:param argparser: unique instance of ArgumentParser
202-
:param ns_provider: an optional function that provides the namespace used in parsing. this is useful
203-
if state data affects how the command line is parsed
202+
:param ns_provider: an optional function that provides the Namespace for parse_known_args().
203+
this is useful if the Namespace needs to be prepopulated based on instance data.
204204
:param preserve_quotes: if True, then arguments passed to argparse maintain their quotes
205205
:return: function that gets passed argparse-parsed args in a Namespace and a list of unknown argument strings
206206
A member called __statement__ is added to the Namespace to provide command functions access to the
@@ -257,8 +257,8 @@ def with_argparser(argparser: argparse.ArgumentParser,
257257
with the given instance of argparse.ArgumentParser.
258258
259259
:param argparser: unique instance of ArgumentParser
260-
:param ns_provider: an optional function that provides the namespace used in parsing. this is useful
261-
if state data affects how the command line is parsed
260+
:param ns_provider: an optional function that provides the Namespace for parse_args().
261+
this is useful if the Namespace needs to be prepopulated based on instance data.
262262
:param preserve_quotes: if True, then arguments passed to argparse maintain their quotes
263263
:return: function that gets passed the argparse-parsed args in a Namespace
264264
A member called __statement__ is added to the Namespace to provide command functions access to the

0 commit comments

Comments
 (0)