docs: polishing source wording #1825
Conversation
…o thinking-steps-docs-polish
| streaming to channels. | ||
| recipient_user_id: The encoded ID of the user to receive the streaming text. Required when streaming to channels. | ||
| task_display_mode: Specifies how tasks are displayed in the message. A "timeline" displays individual tasks | ||
| interleaved with text and "plan" displays all tasks together. |
There was a problem hiding this comment.
i didn't know this word so i'm assuming the average dev doesn't either
There was a problem hiding this comment.
I've heard it tossed around a few times lately and I also felt like I didn't quite know the definition.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## feat-ai-apps-thinking-steps #1825 +/- ##
===============================================================
- Coverage 83.96% 83.95% -0.01%
===============================================================
Files 116 116
Lines 13221 13221
===============================================================
- Hits 11101 11100 -1
- Misses 2120 2121 +1 ☔ View full report in Codecov by Sentry. |
slack_sdk/web/chat_stream.py
Outdated
|
|
||
| Args: | ||
| chunks: An array of streaming chunks that can contain either markdown text or task updates. | ||
| chunks: An array of streaming chunks. Chunks can be markdown text chunks or task update chunks. |
There was a problem hiding this comment.
they can also be plan update 🤓
There was a problem hiding this comment.
oops you totally right
mwbrooks
left a comment
mwbrooks
left a comment
There was a problem hiding this comment.
✅ Thanks for the polish @lukegalbraithrussell! ✨
| streaming to channels. | ||
| recipient_user_id: The encoded ID of the user to receive the streaming text. Required when streaming to channels. | ||
| task_display_mode: Specifies how tasks are displayed in the message. A "timeline" displays individual tasks | ||
| interleaved with text and "plan" displays all tasks together. |
There was a problem hiding this comment.
I've heard it tossed around a few times lately and I also felt like I didn't quite know the definition.
mwbrooks
changed the title
Summary
Makes it so it all matches the api docs
Testing
Category
/docs(Documents)/tutorial(PythOnBoardingBot tutorial)tests/integration_tests(Automated tests for this library)Requirements
python3 -m venv .venv && source .venv/bin/activate && ./scripts/run_validation.shafter making the changes.