fix(types): improve formatting of prop comments

docs/src/COMPONENT_API.json

@@ -91,7 +91,7 @@
         {
           "name": "title",
           "kind": "let",
-          "description": "Specify the title of the accordion item heading\nAlternatively, use the \"title\" slot (e.g., <div slot=\"title\">...</div>)",
+          "description": "Specify the title of the accordion item heading.\nAlternatively, use the \"title\" slot (e.g., `<div slot=\"title\">...</div>`)",
           "type": "string",
           "value": "\"title\"",
           "isFunction": false,
@@ -1024,7 +1024,7 @@
         {
           "name": "code",
           "kind": "let",
-          "description": "Set the code snippet text\nAlternatively, use the default slot (e.g., <CodeSnippet>{`code`}</CodeSnippet>)\nYou must use the `code` prop to copy the code",
+          "description": "Set the code snippet text.\nAlternatively, use the default slot (e.g., `<CodeSnippet>{code}</CodeSnippet>`).\n\nNOTE: you *must* use the `code` prop for the copy-to-clipboard functionality.",
           "type": "string",
           "isFunction": false,
           "isFunctionDeclaration": false,
@@ -1035,7 +1035,7 @@
         {
           "name": "copy",
           "kind": "let",
-          "description": "Override the default copy behavior of using the navigator.clipboard.writeText API to copy text",
+          "description": "By default, this component uses `navigator.clipboard.writeText` API to copy text to the user's clipboard.\n\nProvide a custom function to override this behavior.",
           "type": "(code: string) => void",
           "value": "async (code) => {     try {       await navigator.clipboard.writeText(code);     } catch (e) {       console.log(e);     }   }",
           "isFunction": true,
@@ -1071,7 +1071,7 @@
         {
           "name": "disabled",
           "kind": "let",
-          "description": "Set to `true` for the disabled variant\nOnly applies to the \"single\", \"multi\" types",
+          "description": "Set to `true` for the disabled variant.\nOnly applies to the \"single\", \"multi\" types",
           "type": "boolean",
           "value": "false",
           "isFunction": false,
@@ -1083,7 +1083,7 @@
         {
           "name": "wrapText",
           "kind": "let",
-          "description": "Set to `true` to wrap the text\nNote that `type` must be \"multi\"",
+          "description": "Set to `true` to wrap the text.\n\nNOTE: this prop only works with the `type=\"multi\"` variant",
           "type": "boolean",
           "value": "false",
           "isFunction": false,
@@ -1165,7 +1165,7 @@
         {
           "name": "showLessText",
           "kind": "let",
-          "description": "Specify the show less text\n`type` must be \"multi\"",
+          "description": "Specify the show less text.\n\nNOTE: this prop only works with the `type=\"multi\"` variant",
           "type": "string",
           "value": "\"Show less\"",
           "isFunction": false,
@@ -1177,7 +1177,7 @@
         {
           "name": "showMoreText",
           "kind": "let",
-          "description": "Specify the show more text\n`type` must be \"multi\"",
+          "description": "Specify the show more text\n\nNOTE: this prop only works with the `type=\"multi\"` variant",
           "type": "string",
           "value": "\"Show more\"",
           "isFunction": false,
@@ -2127,7 +2127,7 @@
         {
           "name": "labelText",
           "kind": "let",
-          "description": "Specify the label text\nAlternatively, use the \"labelText\" slot (e.g., <span slot=\"labelText\">...</span>)",
+          "description": "Specify the label text.\nAlternatively, use the \"labelText\" slot (e.g., `<span slot=\"labelText\">...</span>`)",
           "type": "string",
           "value": "\"\"",
           "isFunction": false,
@@ -2163,7 +2163,7 @@
         {
           "name": "shortcutText",
           "kind": "let",
-          "description": "Specify the shortcut text\nAlternatively, use the \"shortcutText\" slot (e.g., <span slot=\"shortcutText\">...</span>)",
+          "description": "Specify the shortcut text.\nAlternatively, use the \"shortcutText\" slot (e.g., `<span slot=\"shortcutText\">...</span>`)",
           "type": "string",
           "value": "\"\"",
           "isFunction": false,
@@ -4892,7 +4892,7 @@
         {
           "name": "text",
           "kind": "let",
-          "description": "Specify the text\nAlternatively, use the named slot \"text\" (e.g., <div slot=\"text\">...</div>)",
+          "description": "Specify the text.\nAlternatively, use the named slot \"text\" (e.g., `<div slot=\"text\">...</div>`)",
           "type": "string",
           "isFunction": false,
           "isFunctionDeclaration": false,
@@ -8128,7 +8128,7 @@
         {
           "name": "text",
           "kind": "let",
-          "description": "Specify the item text\nAlternatively, use the default slot for a custom element",
+          "description": "Specify the item text.\nAlternatively, use the default slot",
           "type": "string",
           "value": "\"Provide text\"",
           "isFunction": false,
@@ -11215,7 +11215,7 @@
         {
           "name": "labelText",
           "kind": "let",
-          "description": "Specify the label text.\nAlternatively, use the \"labelText\" slot (e.g., <span slot=\"labelText\">...</span>)",
+          "description": "Specify the label text.\nAlternatively, use the \"labelText\" slot (e.g., `<span slot=\"labelText\">...</span>`)",
           "type": "string",
           "value": "\"\"",
           "isFunction": false,
@@ -11613,7 +11613,7 @@
         {
           "name": "text",
           "kind": "let",
-          "description": "Specify the switch text\nAlternatively, use the \"text\" slot  (e.g., <span slot=\"text\">...</span>)",
+          "description": "Specify the switch text.\nAlternatively, use the \"text\" slot  (e.g., `<span slot=\"text\">...</span>`)",
           "type": "string",
           "value": "\"Provide text\"",
           "isFunction": false,
@@ -11697,7 +11697,7 @@
         {
           "name": "label",
           "kind": "let",
-          "description": "Specify the tab label\nAlternatively, use the default slot (e.g., <Tab><span>Label</span></Tab>)",
+          "description": "Specify the tab label.\nAlternatively, use the default slot (e.g., `<Tab><span>Label</span></Tab>`)",
           "type": "string",
           "value": "\"\"",
           "isFunction": false,

src/Accordion/AccordionItem.svelte

@@ -1,7 +1,7 @@
 <script>
   /**
-   * Specify the title of the accordion item heading
-   * Alternatively, use the "title" slot (e.g., <div slot="title">...</div>)
+   * Specify the title of the accordion item heading.
+   * Alternatively, use the "title" slot (e.g., `<div slot="title">...</div>`)
    */
   export let title = "title";
 

src/CodeSnippet/CodeSnippet.svelte

@@ -12,15 +12,18 @@
   export let type = "single";
 
   /**
-   * Set the code snippet text
-   * Alternatively, use the default slot (e.g., <CodeSnippet>{`code`}</CodeSnippet>)
-   * You must use the `code` prop to copy the code
+   * Set the code snippet text.
+   * Alternatively, use the default slot (e.g., `<CodeSnippet>{code}</CodeSnippet>`).
+   *
+   * NOTE: you *must* use the `code` prop for the copy-to-clipboard functionality.
    * @type {string}
    */
   export let code = undefined;
 
   /**
-   * Override the default copy behavior of using the navigator.clipboard.writeText API to copy text
+   * By default, this component uses `navigator.clipboard.writeText` API to copy text to the user's clipboard.
+   *
+   * Provide a custom function to override this behavior.
    * @type {(code: string) => void}
    */
   export let copy = async (code) => {
@@ -38,14 +41,15 @@
   export let hideCopyButton = false;
 
   /**
-   * Set to `true` for the disabled variant
+   * Set to `true` for the disabled variant.
    * Only applies to the "single", "multi" types
    */
   export let disabled = false;
 
   /**
-   * Set to `true` to wrap the text
-   * Note that `type` must be "multi"
+   * Set to `true` to wrap the text.
+   *
+   * NOTE: this prop only works with the `type="multi"` variant
    */
   export let wrapText = false;
 
@@ -74,14 +78,16 @@
   export let feedbackTimeout = 2000;
 
   /**
-   * Specify the show less text
-   * `type` must be "multi"
+   * Specify the show less text.
+   *
+   * NOTE: this prop only works with the `type="multi"` variant
    */
   export let showLessText = "Show less";
 
   /**
    * Specify the show more text
-   * `type` must be "multi"
+   *
+   * NOTE: this prop only works with the `type="multi"` variant
    */
   export let showMoreText = "Show more";
 

src/ContentSwitcher/Switch.svelte

@@ -1,7 +1,7 @@
 <script>
   /**
-   * Specify the switch text
-   * Alternatively, use the "text" slot  (e.g., <span slot="text">...</span>)
+   * Specify the switch text.
+   * Alternatively, use the "text" slot  (e.g., `<span slot="text">...</span>`)
    */
   export let text = "Provide text";
 

src/ContextMenu/ContextMenuOption.svelte

@@ -19,8 +19,8 @@
   export let icon = undefined;
 
   /**
-   * Specify the label text
-   * Alternatively, use the "labelText" slot (e.g., <span slot="labelText">...</span>)
+   * Specify the label text.
+   * Alternatively, use the "labelText" slot (e.g., `<span slot="labelText">...</span>`)
    */
   export let labelText = "";
 
@@ -34,8 +34,8 @@
   export let selectable = false;
 
   /**
-   * Specify the shortcut text
-   * Alternatively, use the "shortcutText" slot (e.g., <span slot="shortcutText">...</span>)
+   * Specify the shortcut text.
+   * Alternatively, use the "shortcutText" slot (e.g., `<span slot="shortcutText">...</span>`)
    */
   export let shortcutText = "";
 

src/OverflowMenu/OverflowMenuItem.svelte

@@ -1,7 +1,7 @@
 <script>
   /**
-   * Specify the item text
-   * Alternatively, use the default slot for a custom element
+   * Specify the item text.
+   * Alternatively, use the default slot
    */
   export let text = "Provide text";
 

src/Slider/Slider.svelte

@@ -49,7 +49,7 @@
 
   /**
    * Specify the label text.
-   * Alternatively, use the "labelText" slot (e.g., <span slot="labelText">...</span>)
+   * Alternatively, use the "labelText" slot (e.g., `<span slot="labelText">...</span>`)
    */
   export let labelText = "";
 

src/Tabs/Tab.svelte

@@ -1,7 +1,7 @@
 <script>
   /**
-   * Specify the tab label
-   * Alternatively, use the default slot (e.g., <Tab><span>Label</span></Tab>)
+   * Specify the tab label.
+   * Alternatively, use the default slot (e.g., `<Tab><span>Label</span></Tab>`)
    */
   export let label = "";
 

src/UIShell/HeaderAction.svelte

@@ -22,8 +22,8 @@
   export let closeIcon = Close;
 
   /**
-   * Specify the text
-   * Alternatively, use the named slot "text" (e.g., <div slot="text">...</div>)
+   * Specify the text.
+   * Alternatively, use the named slot "text" (e.g., `<div slot="text">...</div>`)
    * @type {string}
    */
   export let text = undefined;

types/Accordion/AccordionItem.svelte.d.ts

@@ -5,8 +5,8 @@ type RestProps = SvelteHTMLElements["li"];
 
 export interface AccordionItemProps extends RestProps {
   /**
-   * Specify the title of the accordion item heading
-   * Alternatively, use the "title" slot (e.g., <div slot="title">...</div>)
+   * Specify the title of the accordion item heading.
+   * Alternatively, use the "title" slot (e.g., `<div slot="title">...</div>`)
    * @default "title"
    */
   title?: string;

types/CodeSnippet/CodeSnippet.svelte.d.ts

@@ -8,15 +8,18 @@ export interface CodeSnippetProps {
   type?: "single" | "inline" | "multi";
 
   /**
-   * Set the code snippet text
-   * Alternatively, use the default slot (e.g., <CodeSnippet>{`code`}</CodeSnippet>)
-   * You must use the `code` prop to copy the code
+   * Set the code snippet text.
+   * Alternatively, use the default slot (e.g., `<CodeSnippet>{code}</CodeSnippet>`).
+   *
+   * NOTE: you *must* use the `code` prop for the copy-to-clipboard functionality.
    * @default undefined
    */
   code?: string;
 
   /**
-   * Override the default copy behavior of using the navigator.clipboard.writeText API to copy text
+   * By default, this component uses `navigator.clipboard.writeText` API to copy text to the user's clipboard.
+   *
+   * Provide a custom function to override this behavior.
    * @default async (code) => { try { await navigator.clipboard.writeText(code); } catch (e) { console.log(e); } }
    */
   copy?: (code: string) => void;
@@ -34,15 +37,16 @@ export interface CodeSnippetProps {
   hideCopyButton?: boolean;
 
   /**
-   * Set to `true` for the disabled variant
+   * Set to `true` for the disabled variant.
    * Only applies to the "single", "multi" types
    * @default false
    */
   disabled?: boolean;
 
   /**
-   * Set to `true` to wrap the text
-   * Note that `type` must be "multi"
+   * Set to `true` to wrap the text.
+   *
+   * NOTE: this prop only works with the `type="multi"` variant
    * @default false
    */
   wrapText?: boolean;
@@ -84,15 +88,17 @@ export interface CodeSnippetProps {
   feedbackTimeout?: number;
 
   /**
-   * Specify the show less text
-   * `type` must be "multi"
+   * Specify the show less text.
+   *
+   * NOTE: this prop only works with the `type="multi"` variant
    * @default "Show less"
    */
   showLessText?: string;
 
   /**
    * Specify the show more text
-   * `type` must be "multi"
+   *
+   * NOTE: this prop only works with the `type="multi"` variant
    * @default "Show more"
    */
   showMoreText?: string;

types/ContentSwitcher/Switch.svelte.d.ts

@@ -5,8 +5,8 @@ type RestProps = SvelteHTMLElements["button"];
 
 export interface SwitchProps extends RestProps {
   /**
-   * Specify the switch text
-   * Alternatively, use the "text" slot  (e.g., <span slot="text">...</span>)
+   * Specify the switch text.
+   * Alternatively, use the "text" slot  (e.g., `<span slot="text">...</span>`)
    * @default "Provide text"
    */
   text?: string;

types/ContextMenu/ContextMenuOption.svelte.d.ts

@@ -30,8 +30,8 @@ export interface ContextMenuOptionProps extends RestProps {
   icon?: typeof import("svelte").SvelteComponent<any>;
 
   /**
-   * Specify the label text
-   * Alternatively, use the "labelText" slot (e.g., <span slot="labelText">...</span>)
+   * Specify the label text.
+   * Alternatively, use the "labelText" slot (e.g., `<span slot="labelText">...</span>`)
    * @default ""
    */
   labelText?: string;
@@ -50,8 +50,8 @@ export interface ContextMenuOptionProps extends RestProps {
   selectable?: boolean;
 
   /**
-   * Specify the shortcut text
-   * Alternatively, use the "shortcutText" slot (e.g., <span slot="shortcutText">...</span>)
+   * Specify the shortcut text.
+   * Alternatively, use the "shortcutText" slot (e.g., `<span slot="shortcutText">...</span>`)
    * @default ""
    */
   shortcutText?: string;

types/OverflowMenu/OverflowMenuItem.svelte.d.ts

@@ -5,8 +5,8 @@ type RestProps = SvelteHTMLElements["li"];
 
 export interface OverflowMenuItemProps extends RestProps {
   /**
-   * Specify the item text
-   * Alternatively, use the default slot for a custom element
+   * Specify the item text.
+   * Alternatively, use the default slot
    * @default "Provide text"
    */
   text?: string;

types/Slider/Slider.svelte.d.ts

@@ -97,7 +97,7 @@ export interface SliderProps extends RestProps {
 
   /**
    * Specify the label text.
-   * Alternatively, use the "labelText" slot (e.g., <span slot="labelText">...</span>)
+   * Alternatively, use the "labelText" slot (e.g., `<span slot="labelText">...</span>`)
    * @default ""
    */
   labelText?: string;