Skip to content

docs(types): align Alert, Card, Carousel block descriptions with official docs#2578

Merged
srtaalej merged 1 commit intomainfrom
fix-block-descriptions
May 5, 2026
Merged

docs(types): align Alert, Card, Carousel block descriptions with official docs#2578
srtaalej merged 1 commit intomainfrom
fix-block-descriptions

Conversation

@srtaalej
Copy link
Copy Markdown
Contributor

@srtaalej srtaalej commented May 5, 2026

Summary

  • Updates AlertBlock description to "Displays alerts, warnings, and informational messages."
  • Updates CardBlock description to "Displays content in a card."
  • Updates CarouselBlock description to "Displays related card blocks in a horizontally-scrolling container."

These align with the official Slack documentation and follow the existing "Displays..." pattern used by other blocks in the codebase.

Test plan

  • npm run build passes for @slack/types
  • npm test (tsd type tests) passes for @slack/types

@srtaalej srtaalej requested a review from a team as a code owner May 5, 2026 15:35
@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented May 5, 2026

🦋 Changeset detected

Latest commit: 243d857

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@slack/types Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@codecov
Copy link
Copy Markdown

codecov Bot commented May 5, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 87.39%. Comparing base (fde2a7a) to head (243d857).
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2578   +/-   ##
=======================================
  Coverage   87.39%   87.39%           
=======================================
  Files          62       62           
  Lines       10256    10256           
  Branches      415      415           
=======================================
  Hits         8963     8963           
  Misses       1272     1272           
  Partials       21       21           
Flag Coverage Δ
cli-hooks 87.39% <ø> (ø)
cli-test 87.39% <ø> (ø)
logger 87.39% <ø> (ø)
oauth 87.39% <ø> (ø)
socket-mode 87.39% <ø> (ø)
web-api 87.39% <ø> (ø)
webhook 87.39% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copy link
Copy Markdown
Member

@zimeg zimeg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📚 LGTM

@zimeg
Copy link
Copy Markdown
Member

zimeg commented May 5, 2026

@srtaalej Can we add milestones and labels before merging?

@srtaalej srtaalej self-assigned this May 5, 2026
@srtaalej srtaalej added docs M-T: Documentation work only semver:patch pkg:types applies to `@slack/types` labels May 5, 2026
@srtaalej srtaalej modified the milestones: types@3.0.0, types@next, types@3.x May 5, 2026
@srtaalej srtaalej merged commit 9fa2921 into main May 5, 2026
12 checks passed
@srtaalej srtaalej deleted the fix-block-descriptions branch May 5, 2026 17:19
@zimeg zimeg modified the milestones: types@3.x, types@next May 7, 2026
@zimeg
Copy link
Copy Markdown
Member

zimeg commented May 7, 2026

☝️ Changed from "3.x" to "next" so it's included with next release - IIRC "3.x" is for issues but we might want to find a better pattern for this?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs M-T: Documentation work only pkg:types applies to `@slack/types` semver:patch

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants