Skip to content

Commit 6efc023

Browse files
authored
Minor litter cleanup for API documentation (#659)
* use snake case function names to match actual python function defs * use a fully qualified link so links on pypi don't break
1 parent 8bd43b4 commit 6efc023

2 files changed

Lines changed: 7 additions & 5 deletions

File tree

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,9 @@ It is generated with [Stainless](https://www.stainless.com/).
1111

1212
## Documentation
1313

14-
The REST API documentation can be found on [runloop.ai](https://runloop.ai). The full API of this library can be found in [api.md](api.md).
14+
The REST API documentation can be found on
15+
[runloop.ai](https://runloop.ai). The full API of this library can be found in
16+
[api.md](https://github.com/runloopai/api-client-python/blob/main/api.md).
1517

1618
## Installation
1719

src/runloop_api_client/resources/devboxes/devboxes.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -913,7 +913,7 @@ def execute_async(
913913
)
914914

915915
@typing_extensions.deprecated("deprecated")
916-
# Use execute, executeAsync, or executeAndAwaitCompletion instead
916+
# Use execute, execute_async, or execute_and_await_completion instead
917917
def execute_sync(
918918
self,
919919
id: str,
@@ -935,7 +935,7 @@ def execute_sync(
935935
execution.
936936
937937
.. deprecated::
938-
Use execute, executeAsync, or executeAndAwaitCompletion instead.
938+
Use execute, execute_async, or execute_and_await_completion instead.
939939
940940
Args:
941941
command: The command to execute via the Devbox shell. By default, commands are run from
@@ -2394,7 +2394,7 @@ async def execute_async(
23942394
)
23952395

23962396
@typing_extensions.deprecated("deprecated")
2397-
# Use execute, executeAsync, or executeAndAwaitCompletion instead
2397+
# Use execute, execute_async, or execute_and_await_completion instead
23982398
async def execute_sync(
23992399
self,
24002400
id: str,
@@ -2416,7 +2416,7 @@ async def execute_sync(
24162416
execution.
24172417
24182418
.. deprecated::
2419-
Use execute, executeAsync, or executeAndAwaitCompletion instead.
2419+
Use execute, execute_async, or execute_and_await_completion instead.
24202420
24212421
Args:
24222422
command: The command to execute via the Devbox shell. By default, commands are run from

0 commit comments

Comments
 (0)