Skip to content

Commit e1a5dcb

Browse files
committed
Improve doc strings
1 parent 6a28788 commit e1a5dcb

3 files changed

Lines changed: 3 additions & 2 deletions

File tree

packages/js-sdk/src/sandbox/sandboxApi.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,7 @@ export class SandboxApi {
9191
* List all running sandboxes.
9292
*
9393
* @param opts connection options.
94+
* @param opts.filters filter the list of sandboxes by metadata, e.g. `{"key": "value"}, if there are multiple filters they are combined with AND.
9495
*
9596
* @returns list of running sandboxes.
9697
*/

packages/python-sdk/e2b/sandbox_async/sandbox_api.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ async def list(
3030
List all running sandboxes.
3131
3232
:param api_key: API key to use for authentication, defaults to `E2B_API_KEY` environment variable
33-
:param filters: Filter the list of sandboxes by metadata, e.g. `{"key": "value"}`
33+
:param filters: Filter the list of sandboxes by metadata, e.g. `{"key": "value"}`, if there are multiple filters they are combined with AND.
3434
:param domain: Domain to use for the request, only relevant for self-hosted environments
3535
:param debug: Enable debug mode, all requested are then sent to localhost
3636
:param request_timeout: Timeout for the request in **seconds**

packages/python-sdk/e2b/sandbox_sync/sandbox_api.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ def list(
3232
List all running sandboxes.
3333
3434
:param api_key: API key to use for authentication, defaults to `E2B_API_KEY` environment variable
35-
:param filters: Filter the list of sandboxes by metadata, e.g. `{"key": "value"}`
35+
:param filters: Filter the list of sandboxes by metadata, e.g. `{"key": "value"}`, if there are multiple filters they are combined with AND.
3636
:param domain: Domain to use for the request, only relevant for self-hosted environments
3737
:param debug: Enable debug mode, all requested are then sent to localhost
3838
:param request_timeout: Timeout for the request in **seconds**

0 commit comments

Comments
 (0)