Improve doc strings

jakubno · jakubno · commit 6f3a2aeb7af4 · 2025-01-17T14:16:13.000-08:00
diff --git a/packages/js-sdk/src/sandbox/sandboxApi.ts b/packages/js-sdk/src/sandbox/sandboxApi.ts
@@ -13,7 +13,7 @@ export interface SandboxApiOpts
 
 export interface SandboxListOpts extends SandboxApiOpts {
   /**
-   * Filter the list of sandboxes by metadata, e.g. `{"key": "value"}`
+   * Filter the list of sandboxes by metadata, e.g. `{"key": "value"}`, if there are multiple filters they are combined with AND.
    */
   filters?: Record<string, string>
 }
@@ -91,7 +91,6 @@ export class SandboxApi {
    * List all running sandboxes.
    *
    * @param opts connection options.
-   * @param opts.filters filter the list of sandboxes by metadata, e.g. `{"key": "value"}, if there are multiple filters they are combined with AND.
    *
    * @returns list of running sandboxes.
    */

Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ export interface SandboxApiOpts`
`13`	`13`
`14`	`14`	`export interface SandboxListOpts extends SandboxApiOpts {`
`15`	`15`	`/**`
`16`		- * Filter the list of sandboxes by metadata, e.g. `{"key": "value"}`
	`16`	+ * Filter the list of sandboxes by metadata, e.g. `{"key": "value"}`, if there are multiple filters they are combined with AND.
`17`	`17`	`*/`
`18`	`18`	`filters?: Record<string, string>`
`19`	`19`	`}`
`@@ -91,7 +91,6 @@ export class SandboxApi {`
`91`	`91`	`* List all running sandboxes.`
`92`	`92`	`*`
`93`	`93`	`* @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.
`95`	`94`	`*`
`96`	`95`	`* @returns list of running sandboxes.`
`97`	`96`	`*/`