Skip to content

Commit 2eaff32

Browse files
committed
scoped docstrings for public modules, classes and methods
1 parent 8a6f634 commit 2eaff32

14 files changed

Lines changed: 1339 additions & 138 deletions

src/runloop_api_client/sdk/async_.py

Lines changed: 257 additions & 9 deletions
Large diffs are not rendered by default.

src/runloop_api_client/sdk/async_blueprint.py

Lines changed: 44 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,19 @@
1212

1313

1414
class AsyncBlueprint:
15-
"""
16-
Async wrapper around blueprint operations.
17-
"""
15+
"""Asynchronous wrapper around a blueprint resource."""
1816

1917
def __init__(
2018
self,
2119
client: AsyncRunloop,
2220
blueprint_id: str,
2321
) -> None:
22+
"""Initialize the wrapper.
23+
24+
Args:
25+
client: Generated AsyncRunloop client.
26+
blueprint_id: Blueprint ID returned by the API.
27+
"""
2428
self._client = client
2529
self._id = blueprint_id
2630

@@ -30,12 +34,25 @@ def __repr__(self) -> str:
3034

3135
@property
3236
def id(self) -> str:
37+
"""Return the blueprint ID.
38+
39+
Returns:
40+
str: Unique blueprint ID.
41+
"""
3342
return self._id
3443

3544
async def get_info(
3645
self,
3746
**options: Unpack[RequestOptions],
3847
) -> BlueprintView:
48+
"""Retrieve the latest blueprint details.
49+
50+
Args:
51+
**options: Optional request configuration.
52+
53+
Returns:
54+
BlueprintView: API response describing the blueprint.
55+
"""
3956
return await self._client.blueprints.retrieve(
4057
self._id,
4158
**options,
@@ -45,6 +62,14 @@ async def logs(
4562
self,
4663
**options: Unpack[RequestOptions],
4764
) -> BlueprintBuildLogsListView:
65+
"""Retrieve build logs for the blueprint.
66+
67+
Args:
68+
**options: Optional request configuration.
69+
70+
Returns:
71+
BlueprintBuildLogsListView: Log entries for the most recent build.
72+
"""
4873
return await self._client.blueprints.logs(
4974
self._id,
5075
**options,
@@ -54,6 +79,14 @@ async def delete(
5479
self,
5580
**options: Unpack[LongRequestOptions],
5681
) -> object:
82+
"""Delete the blueprint.
83+
84+
Args:
85+
**options: Optional long-running request configuration.
86+
87+
Returns:
88+
object: API response acknowledging deletion.
89+
"""
5790
return await self._client.blueprints.delete(
5891
self._id,
5992
**options,
@@ -63,6 +96,14 @@ async def create_devbox(
6396
self,
6497
**params: Unpack[SDKDevboxExtraCreateParams],
6598
) -> "AsyncDevbox":
99+
"""Create a devbox derived from the blueprint.
100+
101+
Args:
102+
**params: Creation parameters to forward to the devbox API.
103+
104+
Returns:
105+
AsyncDevbox: Wrapper bound to the running devbox.
106+
"""
66107
devbox_view = await self._client.devboxes.create_and_await_running(
67108
blueprint_id=self._id,
68109
**params,

0 commit comments

Comments
 (0)