File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 4343def create_copy_subparser (
4444 parser : argparse .ArgumentParser ,
4545) -> argparse .ArgumentParser :
46- """Augment :class:`argparse.ArgumentParser` with ``copy`` subcommand."""
46+ """Augment :class:`argparse.ArgumentParser` with ``copy`` subcommand.
47+
48+ Examples
49+ --------
50+ >>> import argparse
51+ >>> parser = create_copy_subparser(argparse.ArgumentParser())
52+ >>> args = parser.parse_args(["src", "dst"])
53+ >>> args.source, args.destination
54+ ('src', 'dst')
55+ """
4756 parser .add_argument (
4857 dest = "source" ,
4958 metavar = "source" ,
Original file line number Diff line number Diff line change 4242def create_delete_subparser (
4343 parser : argparse .ArgumentParser ,
4444) -> argparse .ArgumentParser :
45- """Augment :class:`argparse.ArgumentParser` with ``delete`` subcommand."""
45+ """Augment :class:`argparse.ArgumentParser` with ``delete`` subcommand.
46+
47+ Examples
48+ --------
49+ >>> import argparse
50+ >>> parser = create_delete_subparser(argparse.ArgumentParser())
51+ >>> args = parser.parse_args(["proj1", "proj2", "-y"])
52+ >>> args.workspace_names
53+ ['proj1', 'proj2']
54+ >>> args.answer_yes
55+ True
56+ """
4657 parser .add_argument (
4758 dest = "workspace_names" ,
4859 metavar = "workspace-name" ,
Original file line number Diff line number Diff line change 5050def create_new_subparser (
5151 parser : argparse .ArgumentParser ,
5252) -> argparse .ArgumentParser :
53- """Augment :class:`argparse.ArgumentParser` with ``new`` subcommand."""
53+ """Augment :class:`argparse.ArgumentParser` with ``new`` subcommand.
54+
55+ Examples
56+ --------
57+ >>> import argparse
58+ >>> parser = create_new_subparser(argparse.ArgumentParser())
59+ >>> args = parser.parse_args(["myproject"])
60+ >>> args.workspace_name
61+ 'myproject'
62+ """
5463 parser .add_argument (
5564 dest = "workspace_name" ,
5665 metavar = "workspace-name" ,
Original file line number Diff line number Diff line change @@ -47,7 +47,16 @@ class CLIStopNamespace(argparse.Namespace):
4747def create_stop_subparser (
4848 parser : argparse .ArgumentParser ,
4949) -> argparse .ArgumentParser :
50- """Augment :class:`argparse.ArgumentParser` with ``stop`` subcommand."""
50+ """Augment :class:`argparse.ArgumentParser` with ``stop`` subcommand.
51+
52+ Examples
53+ --------
54+ >>> import argparse
55+ >>> parser = create_stop_subparser(argparse.ArgumentParser())
56+ >>> args = parser.parse_args(["mysession"])
57+ >>> args.session_name
58+ 'mysession'
59+ """
5160 parser .add_argument (
5261 dest = "session_name" ,
5362 metavar = "session-name" ,
You can’t perform that action at this time.
0 commit comments