Skip to content

fix(block-kit): set verbatim false on the card block example text - #358

Merged
mwbrooks merged 2 commits into
mainfrom
docs-drift-card
Nov 6, 2026
Merged

mwbrooks merged 2 commits into
mainfrom
docs-drift-card

Conversation

@zimeg

@zimeg zimeg commented Nov 5, 2026

Copy link
Copy Markdown
Member

Summary

This pull request matches the card block example to the card block docs. The docs payload sets verbatim to false on each mrkdwn text object, and the example and its test left it out.

Changes

  • Test payload: add verbatim: false to $.title, $.subtitle and $.body
  • Example: pass verbatim=False to those three MarkdownTextObjects so the example builds the docs payload

The example output now matches the docs JSON field for field. ruff check, ruff format --check, mypy and pytest pass in block-kit, and the block posts with chat.postMessage without errors.

🤖 Generated with Claude Code

Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
@zimeg zimeg added documentation Improvements or additions to documentation python Pull requests that update python code labels Nov 5, 2026
@zimeg zimeg self-assigned this Nov 5, 2026
@zimeg
zimeg marked this pull request as ready for review November 5, 2026 19:36
@zimeg
zimeg requested a review from a team as a code owner November 5, 2026 19:36
@zimeg zimeg changed the title fix(block-kit): match the card block example to the docs fix(block-kit): set verbatim false on the card block example text Nov 5, 2026

@mwbrooks mwbrooks left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

✅ Appreciate this one @zimeg, the card example now builds the docs payload field for field.

subtitle=MarkdownTextObject(text="Committed to work-life balance"),
title=MarkdownTextObject(
text="Lumon Industries",
verbatim=False,

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

praise: All three mrkdwn objects match the docs now, with the test covering each one.

@mwbrooks
mwbrooks merged commit 1c60f9f into main Nov 6, 2026
16 checks passed
@mwbrooks
mwbrooks deleted the docs-drift-card branch November 6, 2026 05:12
@zimeg

zimeg commented Nov 6, 2026

Copy link
Copy Markdown
Member Author

🌟 Thanks for the kind review and merge @mwbrooks!

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

Labels

documentation Improvements or additions to documentation python Pull requests that update python code

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants