Skip to content

Commit 17fd700

Browse files
committed
Deploy: unify argparse descriptions
1 parent eb033c4 commit 17fd700

File tree

1 file changed

+21
-14
lines changed

1 file changed

+21
-14
lines changed

scripts/deploy/deploy_robots.py

+21-14
Original file line numberDiff line numberDiff line change
@@ -74,50 +74,57 @@ def _parse_arguments(self) -> argparse.Namespace:
7474
"--sync",
7575
dest="only_sync",
7676
action="store_true",
77-
help="Only synchronize (copy) files from you to the target machine",
77+
help="Only synchronize (copy) files from you to the target machine.",
7878
)
7979
parser.add_argument(
8080
"-i",
8181
"--install",
8282
dest="only_install",
8383
action="store_true",
84-
help="Only install ROS dependencies on the target",
84+
help="Only install ROS dependencies on the targets.",
8585
)
8686
parser.add_argument(
87-
"-c", "--configure", dest="only_configure", action="store_true", help="Only configure the target machine"
87+
"-c", "--configure", dest="only_configure", action="store_true", help="Only configure the target machines."
8888
)
8989
parser.add_argument(
90-
"-b", "--build", dest="only_build", action="store_true", help="Only build on the target machine"
90+
"-b", "--build", dest="only_build", action="store_true", help="Only build/compile on the target machines."
9191
)
9292
parser.add_argument(
9393
"-l",
9494
"--launch",
9595
dest="only_launch",
9696
action="store_true",
97-
help="Only launch teamplayer software on the target",
97+
help="Only launch teamplayer software on the targets.",
9898
)
9999

100100
# Optional arguments
101-
parser.add_argument("-p", "--package", default="", help="Synchronize and build only the given ROS package")
101+
parser.add_argument("-p", "--package", default="", help="Synchronize and build only the given ROS package.")
102102
parser.add_argument(
103103
"--clean",
104104
action="store_true",
105-
help="Clean complete workspace (source and install, ...) before syncing and building",
105+
help="Clean complete workspace (source and install, ...) before syncing and building.",
106106
)
107-
parser.add_argument("--clean-src", action="store_true", help="Clean source directory before syncing")
107+
parser.add_argument("--clean-src", action="store_true", help="Clean source directory before syncing.")
108108
parser.add_argument(
109109
"--clean-build",
110110
action="store_true",
111-
help="Clean workspace before building. If --package is given, clean only that package",
111+
help="Clean workspace before building. If --package is given, clean only that package.",
112112
)
113113
parser.add_argument("--connection-timeout", default=10, help="Timeout to establish SSH connections in seconds.")
114114
parser.add_argument(
115-
"--print-bit-bot", action="store_true", default=False, help="Print our logo at script start"
115+
"--print-bit-bot", action="store_true", default=False, help="Print our logo at script start."
116+
)
117+
parser.add_argument("-v", "--verbose", action="count", default=0, help="More output.")
118+
parser.add_argument("-q", "--quiet", action="count", default=0, help="Less output.")
119+
parser.add_argument(
120+
"-u", "--user", default="bitbots", help="The SSH user to connect to the target machines with"
121+
)
122+
parser.add_argument(
123+
"-w",
124+
"--workspace",
125+
default="~/colcon_ws",
126+
help="Path to the workspace directory to deploy to. Defaults to '~/colcon_ws'",
116127
)
117-
parser.add_argument("-v", "--verbose", action="count", default=0, help="More output")
118-
parser.add_argument("-q", "--quiet", action="count", default=0, help="Less output")
119-
parser.add_argument("-u", "--user", default="bitbots", help="The user to connect to the target machines with")
120-
parser.add_argument("-w", "--workspace", default="~/colcon_ws", help="The workspace to deploy to")
121128

122129
args = parser.parse_args()
123130

0 commit comments

Comments
 (0)