From c2bb31b9e396482d74a3f33b2c4fb80ef58577b5 Mon Sep 17 00:00:00 2001
From: Oliver Sanders <oliver.sanders@metoffice.gov.uk>
Date: Tue, 20 Feb 2024 10:07:53 +0000
Subject: [PATCH] job runner handers: update submit method docs

* Cylc expects lines, no trailing newline -> submit-fail
---
 cylc/flow/job_runner_handlers/documentation.py | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/cylc/flow/job_runner_handlers/documentation.py b/cylc/flow/job_runner_handlers/documentation.py
index 735b1801b16..1188e0e052c 100644
--- a/cylc/flow/job_runner_handlers/documentation.py
+++ b/cylc/flow/job_runner_handlers/documentation.py
@@ -419,6 +419,14 @@ def submit(
         Returns:
             (ret_code, out, err)
 
+            ret_code:
+                Subprocess return code.
+            out:
+                Subprocess standard output, note this should be newline
+                terminated.
+            err:
+                Subprocess standard error.
+
         """
         raise NotImplementedError()