Skip to content

An open source design system that's fully customizable and agent ready

TypeScript

docs(storybook): remove JS comments from globalIconRegistry @example blocks (#5027)

Joey3ee137eaaa21
diff --git a/packages/core/src/Icon/globalIconRegistry.tsx b/packages/core/src/Icon/globalIconRegistry.tsx
index 1970edf3b4..edff668457 100644
--- a/packages/core/src/Icon/globalIconRegistry.tsx
+++ b/packages/core/src/Icon/globalIconRegistry.tsx
@@ -110,12 +110,12 @@ function getThemeIconOverrides(
* ```
*
* Libraries may also register their own extension keys (any string), so a
- * theme can override them the same way it overrides built-in icons:
+ * theme can override them the same way it overrides built-in icons. A library
+ * that ships its own icons registers them by key, then resolves with
+ * `getIcon('richtext:bold')`.
* @example
* ```
- * // In a library that ships its own icons:
* registerIcons({ 'richtext:bold': <MyBoldIcon /> });
- * // resolve with getIcon('richtext:bold')
* ```
*/
export function registerIcons(
@@ -191,9 +191,10 @@ export function getIcon(
* override the key via {@link registerIcons} without the library having to
* widen the core {@link IconName} union.
*
+ * The `fallback` is the library default, overridable by a theme registering the
+ * same key (for example `'richtext:bold'`).
* @example
* ```
- * // Library default, overridable by a theme registering 'richtext:bold':
* getExtendedIcon('richtext:bold', <BoldGlyph />)
* ```
*/