From e7d392745fe01d933eb984b54ae72cce85f55944 Mon Sep 17 00:00:00 2001 From: Jenny Medina Date: Fri, 27 Sep 2024 12:09:03 -0400 Subject: [PATCH] Update docstrings for getSubmission and getSubmissionStatus --- synapseclient/client.py | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/synapseclient/client.py b/synapseclient/client.py index c38d72dcb..61bcf73c5 100644 --- a/synapseclient/client.py +++ b/synapseclient/client.py @@ -4812,10 +4812,11 @@ def getSubmission( self, id: typing.Union[str, int, collections.abc.Mapping], **kwargs ) -> Submission: """ - Gets a [synapseclient.evaluation.Submission][] object by its id. + Gets a [synapseclient.evaluation.Submission][] object based on a given ID + or previous [synapseclient.evaluation.Submission][] object. Arguments: - id: The id of the submission to retrieve + id: The ID of the submission to retrieve or a [synapseclient.evaluation.Submission][] object Returns: A [synapseclient.evaluation.Submission][] object @@ -4856,13 +4857,13 @@ def getSubmission( return submission def getSubmissionStatus( - self, submission: typing.Union[str, int] + self, submission: typing.Union[str, int, collections.abc.Mapping] ) -> SubmissionStatus: """ - Downloads the status of a Submission. + Downloads the status of a Submission given its ID or previous [synapseclient.evaluation.Submission][] object. Arguments: - submission: The submission to lookup + submission: The submission to lookup (ID or [synapseclient.evaluation.Submission][] object) Returns: A [synapseclient.evaluation.SubmissionStatus][] object