From 789fcb65661f6b8b87e693fa27bc70cb972fedb9 Mon Sep 17 00:00:00 2001 From: Benjamin Canac Date: Thu, 1 Aug 2024 12:05:09 +0200 Subject: [PATCH] docs: use present tense when possible --- docs/content/3.components/alert.md | 2 +- docs/content/3.components/avatar-group.md | 2 +- docs/content/3.components/avatar.md | 4 ++-- docs/content/3.components/breadcrumb.md | 2 +- docs/content/3.components/checkbox.md | 2 +- docs/content/3.components/collapsible.md | 2 +- docs/content/3.components/kbd.md | 2 +- docs/content/3.components/progress.md | 6 +++--- docs/content/3.components/switch.md | 2 +- docs/content/3.components/tooltip.md | 2 +- 10 files changed, 13 insertions(+), 13 deletions(-) diff --git a/docs/content/3.components/alert.md b/docs/content/3.components/alert.md index 14d65546..5aad902e 100644 --- a/docs/content/3.components/alert.md +++ b/docs/content/3.components/alert.md @@ -174,7 +174,7 @@ props: :: ::note -Actions will render differently when the description is not set. You can try to remove it. +Actions renders differently when the description is not set. You can try to remove it. :: ## Examples diff --git a/docs/content/3.components/avatar-group.md b/docs/content/3.components/avatar-group.md index ca5236ed..c976c5fb 100644 --- a/docs/content/3.components/avatar-group.md +++ b/docs/content/3.components/avatar-group.md @@ -49,7 +49,7 @@ slots: ### Max -Use the `max` prop to limit the number of avatars displayed. The rest will be displayed as a `+X` avatar. +Use the `max` prop to limit the number of avatars displayed. The rest is displayed as an `+X` avatar. ::component-code --- diff --git a/docs/content/3.components/avatar.md b/docs/content/3.components/avatar.md index 4398c77d..029c1d32 100644 --- a/docs/content/3.components/avatar.md +++ b/docs/content/3.components/avatar.md @@ -62,7 +62,7 @@ props: ### Alt -When no icon or text is provided, the **initials** of the `alt` prop will be used as fallback. +When no icon or text is provided, the **initials** of the `alt` prop is used as fallback. ::component-code --- @@ -73,7 +73,7 @@ props: :: ::note -The `alt` prop will be used as the `alt` attribute of the image. +The `alt` prop is passed to the `img` element as the `alt` attribute. :: ## Examples diff --git a/docs/content/3.components/breadcrumb.md b/docs/content/3.components/breadcrumb.md index aefc80fa..03050f3d 100644 --- a/docs/content/3.components/breadcrumb.md +++ b/docs/content/3.components/breadcrumb.md @@ -37,7 +37,7 @@ props: :: ::note -A `span` will be rendered instead of a link when the `to` property is not defined. +A `span` is rendered instead of a link when the `to` property is not defined. :: ### Separator diff --git a/docs/content/3.components/checkbox.md b/docs/content/3.components/checkbox.md index 77520eca..6be1a869 100644 --- a/docs/content/3.components/checkbox.md +++ b/docs/content/3.components/checkbox.md @@ -62,7 +62,7 @@ props: --- :: -When using the `required` prop, an asterisk will be added next to the label. +When using the `required` prop, an asterisk is added next to the label. ::component-code --- diff --git a/docs/content/3.components/collapsible.md b/docs/content/3.components/collapsible.md index ec6cc4c1..36f64981 100644 --- a/docs/content/3.components/collapsible.md +++ b/docs/content/3.components/collapsible.md @@ -13,7 +13,7 @@ links: Use a [Button](/components/button) or any other component in the default slot of the Collapsible. -Then, use the `#content` slot to add the content that will be shown when the Collapsible is open. +Then, use the `#content` slot to add the content displayed when the Collapsible is open. ::component-example --- diff --git a/docs/content/3.components/kbd.md b/docs/content/3.components/kbd.md index 68504d68..699e0f89 100644 --- a/docs/content/3.components/kbd.md +++ b/docs/content/3.components/kbd.md @@ -31,7 +31,7 @@ props: --- :: -You can pass special keys to the `value` prop that goes through the [`useKbd`](https://github.com/benjamincanac/ui3/blob/dev/src/runtime/composables/useKbd.ts) composable. For example, the `meta` key will display as `⌘` on macOS and `Ctrl` on other platforms. +You can pass special keys to the `value` prop that goes through the [`useKbd`](https://github.com/benjamincanac/ui3/blob/dev/src/runtime/composables/useKbd.ts) composable. For example, the `meta` key displays as `⌘` on macOS and `Ctrl` on other platforms. ::component-code --- diff --git a/docs/content/3.components/progress.md b/docs/content/3.components/progress.md index a3b3320a..d3d1453c 100644 --- a/docs/content/3.components/progress.md +++ b/docs/content/3.components/progress.md @@ -36,7 +36,7 @@ props: --- :: -Use the `max` prop with an array of strings to display the active step under the bar, the maximum value of the Progress will be the length of the array. +Use the `max` prop with an array of strings to display the active step under the bar, the maximum value of the Progress is the length of the array. ::component-code --- @@ -72,7 +72,7 @@ props: ### Indeterminate -When no `v-model` is set or the value is `null`, the Progress becomes _indeterminate_. The progress bar will be animated as a carousel, but you can change it using the `animation` prop for an inverse carousel, a swinging bar or an elastic bar. +When no `v-model` is set or the value is `null`, the Progress becomes _indeterminate_. The progress bar is animated as a `carousel`, but you can change it using the [`animation`](#animation) prop. ::component-code --- @@ -85,7 +85,7 @@ props: ### Animation -Use the `animation` prop to change the animation of the Progress. Defaults to `carousel`. +Use the `animation` prop to change the animation of the Progress to an inverse carousel, a swinging bar or an elastic bar. Defaults to `carousel`. ::component-code --- diff --git a/docs/content/3.components/switch.md b/docs/content/3.components/switch.md index 35a6034f..d019c3a5 100644 --- a/docs/content/3.components/switch.md +++ b/docs/content/3.components/switch.md @@ -44,7 +44,7 @@ props: --- :: -When using the `required` prop, an asterisk will be added next to the label. +When using the `required` prop, an asterisk is be added next to the label. ::component-code --- diff --git a/docs/content/3.components/tooltip.md b/docs/content/3.components/tooltip.md index b94ce0c3..34cbfc5c 100644 --- a/docs/content/3.components/tooltip.md +++ b/docs/content/3.components/tooltip.md @@ -60,7 +60,7 @@ slots: :: ::tip -You can use special keys there like `meta` that will display as `⌘` on macOS and `Ctrl` on other platforms. +You can use special keys like `meta` that displays as `⌘` on macOS and `Ctrl` on other platforms. :: ### Delay