From 52c953caef5287fd41592548ef522c738adf999e Mon Sep 17 00:00:00 2001 From: Jonxslays <51417989+Jonxslays@users.noreply.github.com> Date: Tue, 28 Dec 2021 16:25:10 -0700 Subject: [PATCH] Update docs --- docs/piston_rspy/index.html | 56 +++++++++++++++++++++++++++++++------ 1 file changed, 48 insertions(+), 8 deletions(-) diff --git a/docs/piston_rspy/index.html b/docs/piston_rspy/index.html index ba69c29..b26000d 100644 --- a/docs/piston_rspy/index.html +++ b/docs/piston_rspy/index.html @@ -62,6 +62,44 @@

Returns:

  • Client: The new client.
    • +
    +def with_url(key: str, /) ‑> Client +
    +
    +

    –

    +

    Creates a new Client with a custom url.

    +

    Args:

    + +

    Returns:

    +
    +
    +
    +def with_url_and_key(key: str, /) ‑> Client +
    +
    +

    –

    +

    Creates a new Client with a custom url and an api key.

    +

    Args:

    + +

    Returns:

    +
    +

    Instance variables

    @@ -97,7 +135,7 @@

    Raises:

    -def fetch_runtimes(self) ‑> list +def fetch_runtimes(self) ‑> list[Runtime]

    –

    @@ -112,7 +150,7 @@

    Raises:

    -def get_headers(self) ‑> dict +def get_headers(self) ‑> dict[str, str]

    –

    @@ -258,7 +296,7 @@

    Returns:

    class Executor -(language: str = '', version: str = '*', files: list = [], stdin: str = '', args: list = [], compile_timeout: int = 10000, run_timeout: int = 3000, compile_memory_limit: int = -1, run_memory_limit: int = -1, /) +(language: str = '', version: str = '*', files: list[File] = [], stdin: str = '', args: list[str] = [], compile_timeout: int = 10000, run_timeout: int = 3000, compile_memory_limit: int = -1, run_memory_limit: int = -1, /)

    –

    @@ -329,7 +367,7 @@

    Returns:

    -def add_args(self, args: list, /) ‑> Executor +def add_args(self, args: list[str], /) ‑> Executor

    –

    @@ -363,7 +401,7 @@

    Returns:

    -def add_files(self, files: list, /) ‑> Executor +def add_files(self, files: list[File], /) ‑> Executor

    –

    @@ -400,7 +438,7 @@

    Returns:

    This method mutates the executor in place.

    -def set_args(self, args: list, /) +def set_args(self, args: list[str], /)

    –

    @@ -446,7 +484,7 @@

    Returns:

    -def set_files(self, files: list, /) +def set_files(self, files: list[File], /)

    –

    @@ -628,7 +666,7 @@

    Returns:

    class Runtime -(language: str, version: str, aliases: list, /) +(language: str, version: str, aliases: list[str], /)

    –

    @@ -693,6 +731,8 @@

    Clientheaders
  • url
  • with_key
    • +
  • with_url
    • +
  • with_url_and_key