Skip to content

docs: add say_stream notes to the experiments page#1463

Open
lukegalbraithrussell wants to merge 2 commits intomainfrom
docs-say_stream-docs
Open

docs: add say_stream notes to the experiments page#1463
lukegalbraithrussell wants to merge 2 commits intomainfrom
docs-say_stream-docs

Conversation

@lukegalbraithrussell
Copy link
Contributor

@lukegalbraithrussell lukegalbraithrussell commented Mar 19, 2026

Summary

This adds docs to the experiments page. No dev preview unless someone requests but i have a picture:

Screenshot 2026-03-18 at 5 08 46 PM

Testing

Category

  • slack_bolt.App and/or its core components
  • slack_bolt.async_app.AsyncApp and/or its core components
  • Adapters in slack_bolt.adapter
  • Document pages under /docs
  • Others

Requirements

Please read the Contributing guidelines and Code of Conduct before creating this issue or pull request. By submitting, you are agreeing to those rules.

  • I've read and understood the Contributing Guidelines and have done my best effort to follow them.
  • I've read and agree to the Code of Conduct.
  • I've run ./scripts/install_all_and_run_tests.sh after making the changes.

"label": "Experiments",
"items": ["tools/bolt-python/experiments"]
},
"tools/bolt-python/experiments",
Copy link
Contributor Author

Choose a reason for hiding this comment

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

this was my bad; should've been a page from the beginning

@codecov
Copy link

codecov bot commented Mar 19, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 91.43%. Comparing base (ba7df02) to head (34530f7).
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1463   +/-   ##
=======================================
  Coverage   91.43%   91.43%           
=======================================
  Files         232      232           
  Lines        7340     7340           
=======================================
  Hits         6711     6711           
  Misses        629      629           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Base automatically changed from say_stream to main March 19, 2026 13:57
@WilliamBergamin WilliamBergamin requested a review from a team as a code owner March 19, 2026 13:57
@zimeg zimeg changed the title Docs: say_stream docs: add say_stream notes to the experiments page Mar 19, 2026
@zimeg zimeg added docs Improvements or additions to documentation semver:patch experiment Experimental feature documented with ExperimentalWarning and pydoc Experiment section labels Mar 19, 2026
@zimeg
Copy link
Member

zimeg commented Mar 19, 2026

⚠️ Merge conflicts bewarned! These commits might show odd diff now I think?

@lukegalbraithrussell
Copy link
Contributor Author

⚠️ Merge conflicts bewarned! These commits might show odd diff now I think?

@zimeg I reset the branch to just be docs changes!

Copy link
Contributor

@WilliamBergamin WilliamBergamin left a comment

Choose a reason for hiding this comment

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

Awesome work on this 🥇 Wasn't sure how to frame all this but this is spot on


## `say_stream` utility {#say-stream}

The `say_stream` utility is a listener argument available on `app.event` and `app.message` listeners.
Copy link
Contributor

Choose a reason for hiding this comment

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

Nice 💯

| `recipient_team_id` | Sourced from the event `team_id` (`enterprise_id` if the app is installed on an org).
| `recipient_user_id` | Sourced from the `user_id` of the event.

If neither a `channel_id` or `thread_ts` can be sourced, then the utility will merely be `None`.
Copy link
Contributor

Choose a reason for hiding this comment

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

Fantastic 🥇

@app.message("")
def handle_message(client: WebClient, say_stream: SayStream):
stream = say_stream()

Copy link
Contributor

Choose a reason for hiding this comment

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

Nit: do we need this empty space?

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

Labels

docs Improvements or additions to documentation experiment Experimental feature documented with ExperimentalWarning and pydoc Experiment section semver:patch

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants