Skip to content

Commit 73fc1f5

Browse files
committed
Update submission and api docs.
1 parent 0f63e3e commit 73fc1f5

File tree

4 files changed

+10
-3
lines changed

4 files changed

+10
-3
lines changed

docs/source/api/api.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@ API Module
33

44
.. automodule:: judge0.api
55
:members:
6-
:undoc-members:
6+
:exclude-members: sync_run, async_run

docs/source/api/submission.rst

+2
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,6 @@ Submission Module
33

44
.. automodule:: judge0.submission
55
:members:
6+
:exclude-members: process_encoded_fields, process_language, process_post_execution_filesystem,
7+
process_status
68
:member-order: groupwise

src/judge0/api.py

+5
Original file line numberDiff line numberDiff line change
@@ -188,6 +188,11 @@ def wait(
188188
retry_strategy : RetryStrategy, optional
189189
A retry strategy.
190190
191+
Returns
192+
-------
193+
Submission or Submissions
194+
A single submission or a list of submissions.
195+
191196
Raises
192197
------
193198
ClientResolutionError

src/judge0/submission.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -208,7 +208,7 @@ def process_language(
208208
return value
209209

210210
def set_attributes(self, attributes: dict[str, Any]) -> None:
211-
"""Set Submissions attributes while taking into account different
211+
"""Set submissions attributes while taking into account different
212212
attribute's types.
213213
214214
Parameters
@@ -236,7 +236,7 @@ def set_attributes(self, attributes: dict[str, Any]) -> None:
236236

237237
def as_body(self, client: "Client") -> dict:
238238
"""Prepare Submission as a dictionary while taking into account
239-
the `client`'s restrictions.
239+
the client's restrictions.
240240
"""
241241
body = {
242242
"source_code": encode(self.source_code),

0 commit comments

Comments
 (0)