Apply suggested correction to jsdoc

MajorLift · erwolff · MajorLift · commit 23c99b9464ff · 2025-08-25T10:28:08.000-04:00
Co-authored-by: Eric Wolff &lt;erwolff@gmail.com&gt;
diff --git a/src/caip-types.ts b/src/caip-types.ts
@@ -143,11 +143,11 @@ export enum KnownCaipNamespace {
 }
 
 /**
- * A CAIP chain ID namespaced by a known CAIP namespace (@see {@link KnownCaipNamespace}).
- * This is a narrower alternative to {@link CaipChainId}.
+ * A CAIP-2 chain ID that is guaranteed to have a known CAIP namespace
+ * (@see {@link KnownCaipNamespace}).
  *
- * This type is necessary because `const` strings are not assignable to the `string` type.
- * Because of this, e.g. `eip155:${string}` is not assignable to (is not a subtype of) `${string}:${string}`.
+ * This is a narrower, more type-safe alternative to {@link CaipChainId} for use cases
+ * where the chain namespace must be one of the known standards.
  */
 export type KnownCaipNamespacedChainId = `${KnownCaipNamespace}:${string}`;
 

Original file line number	Diff line number	Diff line change
`@@ -143,11 +143,11 @@ export enum KnownCaipNamespace {`
`143`	`143`	`}`
`144`	`144`
`145`	`145`	`/**`
`146`		`- * A CAIP chain ID namespaced by a known CAIP namespace (@see {@link KnownCaipNamespace}).`
`147`		`- * This is a narrower alternative to {@link CaipChainId}.`
	`146`	`+ * A CAIP-2 chain ID that is guaranteed to have a known CAIP namespace`
	`147`	`+ * (@see {@link KnownCaipNamespace}).`
`148`	`148`	`*`
`149`		- * This type is necessary because `const` strings are not assignable to the `string` type.
`150`		- * Because of this, e.g. `eip155:${string}` is not assignable to (is not a subtype of) `${string}:${string}`.
	`149`	`+ * This is a narrower, more type-safe alternative to {@link CaipChainId} for use cases`
	`150`	`+ * where the chain namespace must be one of the known standards.`
`151`	`151`	`*/`
`152`	`152`	export type KnownCaipNamespacedChainId = `${KnownCaipNamespace}:${string}`;
`153`	`153`