Spelling/formatting

cylc · Oct 18, 2024 · ae1bef6 · ae1bef6
1 parent da8772c
commit ae1bef6
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 24 deletions.
diff --git a/cylc/flow/cfgspec/globalcfg.py b/cylc/flow/cfgspec/globalcfg.py
@@ -1151,7 +1151,7 @@ def default_for(
                 """)
                 for folder, versionadded in SYMLINKABLE_LOCATIONS.items():
                     Conf(folder, VDR.V_STRING, None, desc=f"""
-                        Alternative location for the log dir.
+                        Alternative location for the {folder} dir.
 
                         If specified the workflow {folder} directory will
                         be created in

diff --git a/cylc/flow/scripts/lint.py b/cylc/flow/scripts/lint.py
@@ -150,11 +150,11 @@
 
 
 DEPRECATED_STRING_TEMPLATES = {
-    'suite': 'workflow',
-    'suite_uuid': 'uuid',
-    'batch_sys_name': 'job_runner_name',
-    'batch_sys_job_id': 'job_id',
-    'user@host': 'platform_name',
+    'suite': '``workflow``',
+    'suite_uuid': '``uuid``',
+    'batch_sys_name': '``job_runner_name``',
+    'batch_sys_job_id': '``job_id``',
+    'user@host': '``platform_name``',
     'task_url': '``URL`` (if set in :cylc:conf:`[meta]URL`)',
     'workflow_url': (
         '``workflow_URL`` (if set in '
@@ -603,22 +603,17 @@ def list_wrapper(line: str, check: Callable) -> Optional[Dict[str, str]]:
             ' rather than job runner directive: ``{directive}``.'
         ),
         'rst': (
-            'Using ``[runtime][TASK]execution time limit`` is'
-            ' recommended in preference to using job runner'
-            ' directives because it allows Cylc to retain awareness'
-            ' of whether the job should have finished, even if contact'
-            ' with the target job runner\'s platform has been lost.'
-            ' \n\nThe following directives are considered equivelent to'
-            ' execution time limit:\n * '
+            "Use :cylc:conf:`flow.cylc[runtime][<namespace>]execution "
+            "time limit` rather than directly specifying a timeout "
+            "directive, otherwise Cylc has no way of knowing when the job "
+            "should have finished. Cylc automatically translates the "
+            "execution time limit to the correct timeout directive for the "
+            "particular job runner:\n"
         )
-        + '\n * '.join((
-            f'``{directive}`` ({job_runner})'
+        + ''.join((
+            f'\n * ``{directive}`` ({job_runner})'
             for job_runner, directive in WALLCLOCK_DIRECTIVES.items()
-        )) + (
-            '\n\n.. note:: Using ``execution time limit`` which'
-            ' is automatically translated to the job runner\'s timeout'
-            ' directive can make your workflow more portable.'
-        ),
+        )),
         FUNCTION: check_wallclock_directives,
     }
 }
@@ -762,12 +757,12 @@ def list_wrapper(line: str, check: Callable) -> Optional[Dict[str, str]]:
         'short': (
             'Deprecated template variables: {suggest}'),
         'rst': (
-            'The following template variables, mostly used in event handlers,'
-            'are deprecated, and should be replaced:'
-            + ''.join([
+            "The following deprecated template variables, mostly used in "
+            "event handlers, should be replaced:\n"
+            + ''.join(
                 f'\n * ``{old}`` ⇒ {new}'
                 for old, new in DEPRECATED_STRING_TEMPLATES.items()
-            ])
+            )
         ),
         'url': (
             'https://cylc.github.io/cylc-doc/stable/html/user-guide/'