Skip to content

Commit 7553de7

Browse files
zimegClaude
andcommitted
docs(block-kit): align carousel description to docs and simplify example doc
- README: use the docs carousel-block description ("Displays related card blocks in a horizontally-scrolling container.") to match the docstring first line. - carousel.py: simplify the specific-example line to "A sample carousel block." (docs description first line + URL kept per AGENTS.md). Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
1 parent 761bb84 commit 7553de7

2 files changed

Lines changed: 2 additions & 3 deletions

File tree

‎block-kit/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Read the [docs](https://docs.slack.dev/block-kit/) to learn concepts behind thes
1111
- **[Actions](https://docs.slack.dev/reference/block-kit/blocks/actions-block)**: Holds multiple interactive elements. [Implementation](./src/blocks/actions.py).
1212
- **[Alert](https://docs.slack.dev/reference/block-kit/blocks/alert-block)**: Displays alerts, warnings, and informational messages. [Implementation](./src/blocks/alert.py).
1313
- **[Card](https://docs.slack.dev/reference/block-kit/blocks/card-block)**: Displays content in a card. [Implementation](./src/blocks/card.py).
14-
- **[Carousel](https://docs.slack.dev/reference/block-kit/blocks/carousel-block)**: Displays a scrollable, horizontal collection of cards. [Implementation](./src/blocks/carousel.py).
14+
- **[Carousel](https://docs.slack.dev/reference/block-kit/blocks/carousel-block)**: Displays related card blocks in a horizontally-scrolling container. [Implementation](./src/blocks/carousel.py).
1515
- **[Context](https://docs.slack.dev/reference/block-kit/blocks/context-block)**: Provides contextual info, which can include both images and text. [Implementation](./src/blocks/context.py).
1616
- **[Context actions](https://docs.slack.dev/reference/block-kit/blocks/context-actions-block)**: Displays actions as contextual info, which can include both feedback buttons and icon buttons. [Implementation](./src/blocks/context_actions.py).
1717
- **[Divider](https://docs.slack.dev/reference/block-kit/blocks/divider-block)**: Visually separates pieces of info inside of a message. [Implementation](./src/blocks/divider.py).

‎block-kit/src/blocks/carousel.py‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,7 @@ def example01() -> CarouselBlock:
88
Displays related card blocks in a horizontally-scrolling container.
99
https://docs.slack.dev/reference/block-kit/blocks/carousel-block/
1010
11-
A carousel with three cards, each with an icon, title, subtitle, hero
12-
image, body, and an action button.
11+
A sample carousel block.
1312
"""
1413
block = CarouselBlock(
1514
elements=[

0 commit comments

Comments
 (0)