Skip to content

Commit

Permalink
Added missing docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
agronholm committed May 1, 2024
1 parent 7f6bb7a commit ec1331e
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions src/asphalt/core/_component.py
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,16 @@ async def start_component(
start_timeout: float | None = 20,
startup_scope: CancelScope | None = None,
) -> None:
"""
Start a component and its subcomponents.
:param component: the (root) component to start
:param start_timeout: seconds to wait for all the components in the hierarchy to
start (default: ``20``; set to ``None`` to disable timeout)
:param startup_scope: used only by :func:`run_application`
:raises RuntimeError: if this function is called without an active :class:`Context`
"""
try:
current_context()
except NoCurrentContext:
Expand Down

0 comments on commit ec1331e

Please sign in to comment.