Add doc comment for select event

Author: probablykasper

src/lib/DateInput.svelte

@@ -8,7 +8,10 @@
   import { writable } from 'svelte/store'
   import { createEventDispatcher } from 'svelte'
 
-  const dispatch = createEventDispatcher<{ select: undefined }>()
+  const dispatch = createEventDispatcher<{
+    /** Fires when the user selects a new value in the DatePicker by clicking on a date or by pressing enter */
+    select: undefined
+  }>()
 
   /** Default date to display in picker before value is assigned */
   const defaultDate = new Date()

src/lib/DatePicker.svelte

@@ -3,7 +3,10 @@
   import { getInnerLocale, type Locale } from './locale.js'
   import { createEventDispatcher } from 'svelte'
 
-  const dispatch = createEventDispatcher<{ select: undefined }>()
+  const dispatch = createEventDispatcher<{
+    /** Fires when the user selects a new value by clicking on a date or by pressing enter */
+    select: undefined
+  }>()
 
   function cloneDate(d: Date) {
     return new Date(d.getTime())

src/routes/docs/+page.md

@@ -29,19 +29,19 @@ The component will not assign a date value until a specific date is selected in
 
 ### Props
 
-| Prop                     | Type         | Description                                          |
-| :----------------------- | :----------- | :--------------------------------------------------- |
-| `value`                  | Date \| null | Date value                                           |
-| `min`                    | Date         | The earliest value the user can select               |
-| `max`                    | Date         | The latest value the user can select                 |
-| `placeholder`            | string       | Placeholder used when date value is null             |
-| `valid`                  | bool         | Whether the text is valid                            |
-| `format`                 | string       | Format string                                        |
-| `visible`                | bool         | Whether the date popup is visible                    |
-| `disabled`               | bool         | Disable the input                                    |
-| `closeOnSelection`       | bool         | Close the date popup when a date is selected         |
-| `browseWithoutSelecting` | bool         | Wait with updating the date until a date is selected |
-| `locale`                 | Locale       | Locale object for internationalization               |
+| Prop                     | Type         | Description                                           |
+| :----------------------- | :----------- | :---------------------------------------------------- |
+| `value`                  | Date \| null | Date value                                            |
+| `min`                    | Date         | The earliest value the user can select                |
+| `max`                    | Date         | The latest value the user can select                  |
+| `placeholder`            | string       | Placeholder used when date value is null              |
+| `valid`                  | bool         | Whether the text is valid                             |
+| `format`                 | string       | Format string                                         |
+| `visible`                | bool         | Whether the date popup is visible                     |
+| `disabled`               | bool         | Disable the input                                     |
+| `closeOnSelection`       | bool         | Close the date popup when a date is selected          |
+| `browseWithoutSelecting` | bool         | Wait with updating the date until a value is selected |
+| `locale`                 | Locale       | Locale object for internationalization                |
 
 #### Format string