Skip to content

Commit 9fa2921

Browse files
authored
docs(types): align Alert, Card, Carousel block descriptions with official docs (#2578)
1 parent fde2a7a commit 9fa2921

2 files changed

Lines changed: 8 additions & 4 deletions

File tree

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
'@slack/types': patch
3+
---
4+
5+
Align Alert, Card, and Carousel block type descriptions with official documentation

packages/types/src/block-kit/blocks.ts

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ export interface ActionsBlock extends Block {
113113
}
114114

115115
/**
116-
* @description A prominent notice block for displaying warnings, status updates, or other important information.
116+
* @description Displays alerts, warnings, and informational messages.
117117
* @see {@link https://docs.slack.dev/reference/block-kit/blocks/alert-block Alert block reference}.
118118
*/
119119
export interface AlertBlock extends Block {
@@ -132,8 +132,7 @@ export interface AlertBlock extends Block {
132132
}
133133

134134
/**
135-
* @description A rich display block for presenting structured content such as recommendations, results, or work items.
136-
* At least one of `hero_image`, `title`, `actions`, or `body` must be provided.
135+
* @description Displays content in a card. At least one of `hero_image`, `title`, `actions`, or `body` must be provided.
137136
* @see {@link https://docs.slack.dev/reference/block-kit/blocks/card-block Card block reference}.
138137
*/
139138
export interface CardBlock extends Block {
@@ -171,7 +170,7 @@ export interface CardBlock extends Block {
171170
}
172171

173172
/**
174-
* @description A horizontally scrollable collection of {@link CardBlock} elements.
173+
* @description Displays related card blocks in a horizontally-scrolling container.
175174
* @see {@link https://docs.slack.dev/reference/block-kit/blocks/carousel-block Carousel block reference}.
176175
*/
177176
export interface CarouselBlock extends Block {

0 commit comments

Comments
 (0)