From e8ce85aba26f284758f66ddff8e58f859e24c1bb Mon Sep 17 00:00:00 2001 From: Oliver Sanders Date: Mon, 13 Jan 2025 11:29:38 +0000 Subject: [PATCH] cli: correct --comms-timeout docs --- cylc/flow/option_parsers.py | 11 +++++++---- cylc/flow/scripts/tui.py | 8 ++++---- 2 files changed, 11 insertions(+), 8 deletions(-) diff --git a/cylc/flow/option_parsers.py b/cylc/flow/option_parsers.py index 8a4245a6a94..5c137515cb0 100644 --- a/cylc/flow/option_parsers.py +++ b/cylc/flow/option_parsers.py @@ -317,10 +317,13 @@ class CylcOptionParser(OptionParser): OptionSettings( ['--comms-timeout'], metavar='SEC', help=( - "Set a timeout for network connections" - " to the running workflow. The default is no timeout." - " For task messaging connections see" - " site/user config file documentation." + "Set the timeout for communication with the running workflow." + " The default is determined by the setup, 5 seconds for" + " TCP comms and 300 for SSH." + " If connections timeout, it likely means either, a complex" + " request has been issued (e.g. cylc tui); there is a network" + " issue; or a problem with the scheduler. Increasing the" + " timeout will help with the first case." ), action='store', default=None, dest='comms_timeout', useif='comms'), OptionSettings( diff --git a/cylc/flow/scripts/tui.py b/cylc/flow/scripts/tui.py index 1958fc05132..d141c2d2524 100644 --- a/cylc/flow/scripts/tui.py +++ b/cylc/flow/scripts/tui.py @@ -65,10 +65,10 @@ def get_option_parser() -> COP: '--comms-timeout', metavar='SEC', help=( - "Set a timeout for network connections" - " to the running workflow. The default is 3 seconds." - " For task messaging connections see" - " site/user config file documentation." + # NOTE: Tui overrides the default client timeout + "Set the timeout for communication with the running workflow." + " The default is 3 seconds, uou may need to increase this in" + "order for Tui to keep up with especially busy workflows." ), action='store', default=3,