Skip to content

Commit

Permalink
docs: add api docs for expose (#1130)
Browse files Browse the repository at this point in the history
* docs: add api docs for expose

Signed-off-by: nullday <aseaday@hotmail.com>

* Reformat

Signed-off-by: nullday <aseaday@hotmail.com>

Signed-off-by: nullday <aseaday@hotmail.com>
  • Loading branch information
aseaday authored Nov 1, 2022
1 parent 7bf8c00 commit 3233cd6
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion envd/api/runtime/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,12 @@ def command(commands: Dict[str, str]):
"""


def expose(envd_port: str, host_port: Optional[str], service: Optional[str]):
def expose(
envd_port: str,
host_port: Optional[str],
service: Optional[str],
listen_addr: Optional[str],
):
"""Expose port to host
Proposal: https://github.com/tensorchord/envd/pull/780
Expand All @@ -51,6 +56,7 @@ def expose(envd_port: str, host_port: Optional[str], service: Optional[str]):
host_port (Optional[str]): port in the host, if not provided or
`host_port=0`, `envd` will randomly choose a free port
service (Optional[str]): service name
listen_addr (Optional[str]): address to listen on
"""


Expand Down

0 comments on commit 3233cd6

Please sign in to comment.