Skip to content

Commit 150255d

Browse files
rotudirk-thomas
andauthored
Help text nudge to read the friendly manual (#327)
* Help text nudge to read the friendly manual * remove help text when no verb provided * Change name of constant * avoid alignment of wrapped lines * save some vertical space (as it was before) Co-authored-by: Dirk Thomas <[email protected]>
1 parent af7fa08 commit 150255d

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

colcon_core/command.py

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -211,8 +211,10 @@ def _parse_optional(self, arg_string):
211211
parser = CustomArgumentParser(
212212
prog=get_prog_name(),
213213
formatter_class=CustomFormatter,
214-
epilog=get_environment_variables_epilog(
215-
environment_variables_group_name))
214+
epilog=(
215+
get_environment_variables_epilog(
216+
environment_variables_group_name
217+
) + '\n\n' + READTHEDOCS_MESSAGE))
216218

217219
# enable introspecting and intercepting all command line arguments
218220
parser = decorate_argument_parser(parser)
@@ -268,6 +270,10 @@ def get_environment_variables_epilog(group_name):
268270
return 'Environment variables:\n' + '\n'.join(epilog_lines)
269271

270272

273+
READTHEDOCS_MESSAGE = 'For more help and usage tips, see ' \
274+
'https://colcon.readthedocs.io'
275+
276+
271277
def add_log_level_argument(parser):
272278
"""
273279
Add the argument for the log level to the parser.

0 commit comments

Comments
 (0)