Tweaked the JSDoc to make the prefixing clearer

matt-aitken · matt-aitken · commit 37d6e8a4a3e5 · 2024-07-23T16:24:57.000+01:00
diff --git a/packages/trigger-sdk/src/v3/shared.ts b/packages/trigger-sdk/src/v3/shared.ts
@@ -447,7 +447,7 @@ export type TaskRunOptions = {
    *
    * You can set up to 3 tags per run, they must be less than 64 characters each.
    *
-   * We recommend prefixing tags with a namespace, like `user:1234567` or `org:9876543`.
+   * We recommend prefixing tags with a namespace using an underscore or colon, like `user_1234567` or `org:9876543`.
    *
    * @example
    *

Original file line number	Diff line number	Diff line change
`@@ -447,7 +447,7 @@ export type TaskRunOptions = {`
`447`	`447`	`*`
`448`	`448`	`* You can set up to 3 tags per run, they must be less than 64 characters each.`
`449`	`449`	`*`
`450`		- * We recommend prefixing tags with a namespace, like `user:1234567` or `org:9876543`.
	`450`	+ * We recommend prefixing tags with a namespace using an underscore or colon, like `user_1234567` or `org:9876543`.
`451`	`451`	`*`
`452`	`452`	`* @example`
`453`	`453`	`*`