Skip to content

Commit 6f8126f

Browse files
committed
clean up class docstrings
1 parent a62491d commit 6f8126f

7 files changed

Lines changed: 23 additions & 42 deletions

File tree

docs/conf.py

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@
1515
project = "Runloop Python SDK"
1616
copyright = "2025, Runloop"
1717
author = "Runloop"
18-
release = "0.68.0"
1918

2019
# -- General configuration ---------------------------------------------------
2120
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
@@ -40,13 +39,6 @@
4039

4140
# -- Extension configuration -------------------------------------------------
4241

43-
# Napoleon settings
44-
napoleon_google_docstring = False
45-
napoleon_numpy_docstring = False
46-
napoleon_use_param = True
47-
napoleon_use_rtype = True
48-
napoleon_use_ivar = True
49-
5042
# Autodoc settings
5143
autodoc_default_options = {
5244
"members": None,
@@ -58,5 +50,4 @@
5850
# Intersphinx mapping
5951
intersphinx_mapping = {
6052
"python": ("https://docs.python.org/3", None),
61-
"httpx": ("https://www.python-httpx.org", None),
6253
}

src/runloop_api_client/sdk/async_.py

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -422,12 +422,16 @@ class AsyncRunloopSDK:
422422
blueprints, snapshots, and storage objects. Exposes the generated async REST
423423
client via the ``api`` attribute for advanced use cases.
424424
425-
Attributes:
426-
api: Direct access to the generated async REST API client.
427-
devbox: High-level async interface for devbox management.
428-
blueprint: High-level async interface for blueprint management.
429-
snapshot: High-level async interface for snapshot management.
430-
storage_object: High-level async interface for storage object management.
425+
:ivar api: Direct access to the generated async REST API client
426+
:vartype api: AsyncRunloop
427+
:ivar devbox: High-level async interface for devbox management
428+
:vartype devbox: AsyncDevboxOps
429+
:ivar blueprint: High-level async interface for blueprint management
430+
:vartype blueprint: AsyncBlueprintOps
431+
:ivar snapshot: High-level async interface for snapshot management
432+
:vartype snapshot: AsyncSnapshotOps
433+
:ivar storage_object: High-level async interface for storage object management
434+
:vartype storage_object: AsyncStorageObjectOps
431435
432436
Example:
433437
>>> runloop = AsyncRunloopSDK() # Uses RUNLOOP_API_KEY env var

src/runloop_api_client/sdk/async_devbox.py

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -60,12 +60,6 @@ class AsyncDevbox:
6060
... result = await devbox.cmd.exec(command="echo 'hello'")
6161
... print(await result.stdout())
6262
# Devbox is automatically shut down on exit
63-
64-
Attributes:
65-
id: The devbox identifier.
66-
cmd: Command execution interface (exec, exec_async).
67-
file: File operations interface (read, write, upload, download).
68-
net: Network operations interface (SSH keys, tunnels).
6963
"""
7064

7165
def __init__(self, client: AsyncRunloop, devbox_id: str) -> None:

src/runloop_api_client/sdk/async_execution.py

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,10 +42,6 @@ class AsyncExecution:
4242
Provides coroutines to poll execution state, wait for completion, and
4343
terminate the running process. Created by ``await devbox.cmd.exec_async()``.
4444
45-
Attributes:
46-
execution_id: The unique execution identifier.
47-
devbox_id: The devbox where the command is executing.
48-
4945
Example:
5046
>>> execution = await devbox.cmd.exec_async(command="python train.py")
5147
>>> state = await execution.get_state()

src/runloop_api_client/sdk/devbox.py

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -52,17 +52,13 @@ class Devbox:
5252
This class provides a Pythonic, object-oriented API for interacting with devboxes,
5353
including command execution, file operations, networking, and lifecycle management.
5454
55-
The Devbox class supports context manager protocol for automatic cleanup:
55+
The Devbox class supports context manager protocol for automatic cleanup.
56+
57+
Example:
5658
>>> with sdk.devbox.create(name="my-devbox") as devbox:
5759
... result = devbox.cmd.exec("echo 'hello'")
5860
... print(result.stdout())
5961
# Devbox is automatically shutdown on exit
60-
61-
Attributes:
62-
id: The devbox identifier.
63-
cmd: Command execution interface (exec, exec_async).
64-
file: File operations interface (read, write, upload, download).
65-
net: Network operations interface (SSH keys, tunnels).
6662
"""
6763

6864
def __init__(self, client: Runloop, devbox_id: str) -> None:

src/runloop_api_client/sdk/execution.py

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,10 +41,6 @@ class Execution:
4141
Provides methods to poll execution state, wait for completion, and terminate
4242
the running process. Created by ``devbox.cmd.exec_async()``.
4343
44-
Attributes:
45-
execution_id: The unique execution identifier.
46-
devbox_id: The devbox where the command is executing.
47-
4844
Example:
4945
>>> execution = devbox.cmd.exec_async(command="python train.py")
5046
>>> state = execution.get_state()

src/runloop_api_client/sdk/sync.py

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -422,12 +422,16 @@ class RunloopSDK:
422422
snapshots, and storage objects. Exposes the generated REST client via the ``api``
423423
attribute for advanced use cases.
424424
425-
Attributes:
426-
api: Direct access to the generated REST API client.
427-
devbox: High-level interface for devbox management.
428-
blueprint: High-level interface for blueprint management.
429-
snapshot: High-level interface for snapshot management.
430-
storage_object: High-level interface for storage object management.
425+
:ivar api: Direct access to the generated REST API client
426+
:vartype api: Runloop
427+
:ivar devbox: High-level interface for devbox management
428+
:vartype devbox: DevboxOps
429+
:ivar blueprint: High-level interface for blueprint management
430+
:vartype blueprint: BlueprintOps
431+
:ivar snapshot: High-level interface for snapshot management
432+
:vartype snapshot: SnapshotOps
433+
:ivar storage_object: High-level interface for storage object management
434+
:vartype storage_object: StorageObjectOps
431435
432436
Example:
433437
>>> runloop = RunloopSDK() # Uses RUNLOOP_API_KEY env var

0 commit comments

Comments
 (0)