From 63ede702ecf9f46016cd4f6037232b42309770fe Mon Sep 17 00:00:00 2001 From: Gregory Cage Date: Wed, 29 May 2024 15:04:49 -0400 Subject: [PATCH] Fix docstrings that refer to tool stdout as job stdout --- client/src/api/schema/schema.ts | 14 +++++++------- lib/galaxy/schema/jobs.py | 4 ++-- lib/galaxy/webapps/galaxy/api/jobs.py | 4 ++-- 3 files changed, 11 insertions(+), 11 deletions(-) diff --git a/client/src/api/schema/schema.ts b/client/src/api/schema/schema.ts index a13a0673d97b..e5bb4b249806 100644 --- a/client/src/api/schema/schema.ts +++ b/client/src/api/schema/schema.ts @@ -1084,9 +1084,9 @@ export interface paths { }; "/api/jobs/{job_id}/console_output": { /** - * Returns STDOUT and STDERR from job. - * @description Get the stdout and/or stderr of a job. The position parameters are the index - * of where to start reading stdout/stderr. The length parameterscontrol how much + * Returns STDOUT and STDERR from the tool running in a specific job. + * @description Get the stdout and/or stderr of a tool running in a specific job. The position parameters are the index + * of where to start reading stdout/stderr. The length parameters control how much * stdout/stderr is read. */ get: operations["get_console_output_api_jobs__job_id__console_output_get"]; @@ -8478,12 +8478,12 @@ export interface components { state?: components["schemas"]["JobState"] | null; /** * STDERR - * @description Job STDERR text + * @description Tool STDERR text from the tool running in a specific job */ stderr?: string | null; /** * STDOUT - * @description Job STDOUT text + * @description Tool STDOUT text from the tool running in a specific job */ stdout?: string | null; }; @@ -19435,8 +19435,8 @@ export interface operations { }; get_console_output_api_jobs__job_id__console_output_get: { /** - * Returns STDOUT and STDERR from job. - * @description Get the stdout and/or stderr of a job. The position parameters are the index + * Returns STDOUT and STDERR from the tool running in a specific job. + * @description Get the stdout and/or stderr from the tool running in a specific job. The position parameters are the index * of where to start reading stdout/stderr. The length parameterscontrol how much * stdout/stderr is read. */ diff --git a/lib/galaxy/schema/jobs.py b/lib/galaxy/schema/jobs.py index 52ba6a208d27..b6d67b7d2a42 100644 --- a/lib/galaxy/schema/jobs.py +++ b/lib/galaxy/schema/jobs.py @@ -214,8 +214,8 @@ class JobOutput(Model): class JobConsoleOutput(Model): state: Optional[JobState] = Field(None, title="Job State", description="The current job's state") - stdout: Optional[str] = Field(None, title="STDOUT", description="Job STDOUT text") - stderr: Optional[str] = Field(None, title="STDERR", description="Job STDERR text") + stdout: Optional[str] = Field(None, title="STDOUT", description="Tool STDOUT from job.") + stderr: Optional[str] = Field(None, title="STDERR", description="Tool STDERR from job.") class JobParameter(Model): diff --git a/lib/galaxy/webapps/galaxy/api/jobs.py b/lib/galaxy/webapps/galaxy/api/jobs.py index b8ff2d8350a1..10242f38d75d 100644 --- a/lib/galaxy/webapps/galaxy/api/jobs.py +++ b/lib/galaxy/webapps/galaxy/api/jobs.py @@ -372,7 +372,7 @@ def outputs( @router.get( "/api/jobs/{job_id}/console_output", name="get_console_output", - summary="Returns STDOUT and STDERR from job.", + summary="Returns STDOUT and STDERR from the tool running in a specific job.", ) def console_output( self, @@ -384,7 +384,7 @@ def console_output( trans: ProvidesUserContext = DependsOnTrans, ) -> JobConsoleOutput: """ - Get the stdout and/or stderr of a job. The position parameters are the index + Get the stdout and/or stderr from the tool running in a specific job. The position parameters are the index of where to start reading stdout/stderr. The length parameters control how much stdout/stderr is read. """