docs: add say_stream notes to the experiments page#1463
docs: add say_stream notes to the experiments page#1463lukegalbraithrussell wants to merge 2 commits intodocs-agent-kitfrom
Conversation
| "label": "Experiments", | ||
| "items": ["tools/bolt-python/experiments"] | ||
| }, | ||
| "tools/bolt-python/experiments", |
There was a problem hiding this comment.
this was my bad; should've been a page from the beginning
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## docs-agent-kit #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. |
zimeg
changed the title
zimeg
added
docs
|
|
lukegalbraithrussell
force-pushed
the
docs-say_stream-docs
branch
from
6048885 to
422c62f
Compare
@zimeg I reset the branch to just be docs changes! |
WilliamBergamin
left a comment
WilliamBergamin
left a comment
There was a problem hiding this comment.
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. |
| | `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`. |
| @app.message("") | ||
| def handle_message(client: WebClient, say_stream: SayStream): | ||
| stream = say_stream() | ||
|
|
There was a problem hiding this comment.
Nit: do we need this empty space?
3 participants
Summary
This adds docs to the experiments page. No dev preview unless someone requests but i have a picture:
Testing
Category
slack_bolt.Appand/or its core componentsslack_bolt.async_app.AsyncAppand/or its core componentsslack_bolt.adapter/docsRequirements
Please read the Contributing guidelines and Code of Conduct before creating this issue or pull request. By submitting, you are agreeing to those rules.
./scripts/install_all_and_run_tests.shafter making the changes.