docs: precede code snippet with standard sentence formatting#2673
Merged
docs: precede code snippet with standard sentence formatting#2673
Conversation
zimeg
commented
Oct 6, 2025
Member
Author
zimeg
left a comment
zimeg
left a comment
There was a problem hiding this comment.
📝 Notes for the wonderful reviewers!
| app.event('reaction_added', async ({ event, say }) => { | ||
| if (event.reaction === 'calendar') { | ||
| await say({ | ||
| blocks: [{ |
Member
Author
There was a problem hiding this comment.
🪬 note: Refactoring this to make copy and pasting a bit easier!
Comment on lines
+52
to
+54
| - [`chat.startStream`](/reference/methods/chat.startstream) | ||
| - [`chat.appendStream`](/reference/methods/chat.appendstream) | ||
| - [`chat.stopStream`](/reference/methods/chat.stopstream) |
Member
Author
There was a problem hiding this comment.
👁️🗨️ note: Using dashes instead of asterisk to avoid possible confusion with markdown in the listed item-
| - [`chat.stopStream`](/reference/methods/chat.stopstream) | ||
|
|
||
| The Node Slack SDK provides a [`chatStream()`](/tools/node-slack-sdk/reference/web-api/classes/WebClient#chatstream) helper utility to streamline calling these methods. Here's an excerpt from our [Assistant template app](https://github.com/slack-samples/bolt-js-assistant-template) | ||
| The Node Slack SDK provides a [`chatStream()`](/tools/node-slack-sdk/reference/web-api/classes/WebClient#chatstream) helper utility to streamline calling these methods. Here's an excerpt from our [Assistant template app](https://github.com/slack-samples/bolt-js-assistant-template): |
Member
Author
There was a problem hiding this comment.
🗣️ note: This is the big change of the PR!
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## ai-apps #2673 +/- ##
========================================
Coverage 93.40% 93.40%
========================================
Files 37 37
Lines 7613 7613
Branches 668 668
========================================
Hits 7111 7111
Misses 497 497
Partials 5 5 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
haleychaas
approved these changes
Oct 6, 2025
Member
Author
|
@haleychaas @srtaalej Thanks for the kind reviews! Let's merge this for a publish soon 🚢 💨 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR improves the formatting of a code snippet following a link.
Requirements