Skip to content

Commit 008a010

Browse files
authored
Merge pull request #900 from tisnik/lcore-1092-better-docstring-for-uvicorn-runner
LCORE-1092: Better docstring for Uvicorn runner
2 parents 146f9a0 + 8a91fb5 commit 008a010

1 file changed

Lines changed: 9 additions & 1 deletion

File tree

src/runners/uvicorn.py

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,15 @@
1010

1111

1212
def start_uvicorn(configuration: ServiceConfiguration) -> None:
13-
"""Start Uvicorn-based REST API service."""
13+
"""
14+
Start the Uvicorn server using the provided service configuration.
15+
16+
Parameters:
17+
configuration (ServiceConfiguration): Configuration providing host,
18+
port, workers, and `tls_config` (including `tls_key_path`,
19+
`tls_certificate_path`, and `tls_key_password`). TLS fields may be None
20+
and will be forwarded to uvicorn.run as provided.
21+
"""
1422
logger.info("Starting Uvicorn")
1523

1624
log_level = logging.INFO

0 commit comments

Comments
 (0)