Skip to content

Commit

Permalink
chore: fix outdated base backend docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
davidlougheed committed Mar 12, 2024
1 parent ebb209d commit 95bf5b0
Showing 1 changed file with 5 additions and 6 deletions.
11 changes: 5 additions & 6 deletions bento_wes/backends/_wes_backend.py
Original file line number Diff line number Diff line change
Expand Up @@ -157,9 +157,9 @@ def _params_path(self, run: Run) -> Path:
@abstractmethod
def _check_workflow(self, run: Run) -> None:
"""
Checks that a workflow can be executed by the backend via the workflow's URI.
Checks that a workflow can be executed by the backend via the workflow's URI. A RunExceptionWithFailState is
raised if the workflow is not valid.
:param run: The run, including a request with the workflow URI
:return: None if the workflow is valid; a tuple of an error message and an error state otherwise
"""
pass

Expand Down Expand Up @@ -191,9 +191,8 @@ def execute_womtool_command(cls, command: tuple[str, ...]) -> subprocess.Popen:

def _check_workflow_wdl(self, run: RunWithDetails) -> None:
"""
Checks that a particular WDL workflow is valid.
Checks that a particular WDL workflow is valid. A RunExceptionWithFailState is raised if the WDL is not valid.
:param run: The run whose workflow is being checked
:return: None if the workflow is valid; a tuple of an error message and an error state otherwise
"""

# Validate WDL, listing dependencies:
Expand All @@ -219,9 +218,9 @@ def _check_workflow_wdl(self, run: RunWithDetails) -> None:

def _check_workflow_and_type(self, run: RunWithDetails) -> None:
"""
Checks a workflow file's validity.
Checks a workflow file's validity. A RunExceptionWithFailState is raised if the workflow file is not valid.
A NotImplementedError is raised if the workflow type is not supported by the backend.
:param run: The run specifying the workflow in question
:return: None if the workflow is valid; a tuple of an error message and an error state otherwise
"""

workflow_type: WorkflowType = WorkflowType(run.request.workflow_type)
Expand Down

0 comments on commit 95bf5b0

Please sign in to comment.