Skip to content

Minor litter cleanup for API documentation #659

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jrvb-rl merged 2 commits into from
Oct 30, 2025
Merged

Minor litter cleanup for API documentation #659

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a92f389
use snake case function names to match actual python function defs
jrvb-rl Oct 30, 2025
afe05bf
use a fully qualified link so links on pypi don't break
jrvb-rl Oct 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,9 @@ It is generated with [Stainless](https://www.stainless.com/).

## Documentation

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).
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](https://github.com/runloopai/api-client-python/blob/main/api.md).

## Installation

Expand Down
8 changes: 4 additions & 4 deletions src/runloop_api_client/resources/devboxes/devboxes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -913,7 +913,7 @@ def execute_async(
)

@typing_extensions.deprecated("deprecated")
# Use execute, executeAsync, or executeAndAwaitCompletion instead
# Use execute, execute_async, or execute_and_await_completion instead
def execute_sync(
self,
id: str,
Expand All @@ -935,7 +935,7 @@ def execute_sync(
execution.

.. deprecated::
Use execute, executeAsync, or executeAndAwaitCompletion instead.
Use execute, execute_async, or execute_and_await_completion instead.

Args:
command: The command to execute via the Devbox shell. By default, commands are run from
Expand Down Expand Up @@ -2394,7 +2394,7 @@ async def execute_async(
)

@typing_extensions.deprecated("deprecated")
# Use execute, executeAsync, or executeAndAwaitCompletion instead
# Use execute, execute_async, or execute_and_await_completion instead
async def execute_sync(
self,
id: str,
Expand All @@ -2416,7 +2416,7 @@ async def execute_sync(
execution.

.. deprecated::
Use execute, executeAsync, or executeAndAwaitCompletion instead.
Use execute, execute_async, or execute_and_await_completion instead.

Args:
command: The command to execute via the Devbox shell. By default, commands are run from
Expand Down