docs: fix critical inaccuracies in English documentation#1512
Conversation
Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
| Once in VSCode, open the terminal. Let's install our package dependencies: run the following command(s) in the terminal inside VSCode: | ||
|
|
||
| ```sh | ||
| npm install |
There was a problem hiding this comment.
oopssssss
There was a problem hiding this comment.
@lukegalbraithrussell A fix is great to find! Thanks! 📚 ✨
📺 thought: We might want to prefer steps using the CLI in ongoing iteration but not a blocker for this!
Co-authored-by: Luke Russell <31357343+lukegalbraithrussell@users.noreply.github.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1512 +/- ##
=======================================
Coverage 91.30% 91.30%
=======================================
Files 228 228
Lines 7271 7271
=======================================
Hits 6639 6639
Misses 632 632 ☔ View full report in Codecov by Sentry. |
zimeg
left a comment
zimeg
left a comment
There was a problem hiding this comment.
Glad to read these improvements - thanks for a good eye 👁️🗨️
The one note I write is about CLI support but this is adjacent to what this PR intends so please ignore it. I'm also uncertain of the best practice for exceptions FWIW!
| | `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 be `None`. | ||
| If either `channel_id` or `thread_ts` cannot be sourced, the utility will be `None`. |
There was a problem hiding this comment.
💡 praise: Single truths are simple for me to follow thanks!
| Once in VSCode, open the terminal. Let's install our package dependencies: run the following command(s) in the terminal inside VSCode: | ||
|
|
||
| ```sh | ||
| npm install |
There was a problem hiding this comment.
@lukegalbraithrussell A fix is great to find! Thanks! 📚 ✨
📺 thought: We might want to prefer steps using the CLI in ongoing iteration but not a blocker for this!
| ```py | ||
| @app.function("sample_step") | ||
| def handle_sample_step_event(inputs: dict, fail: Fail, complete: Complete,logger: logging.Logger): | ||
| def handle_sample_step_event(client: WebClient, inputs: dict, fail: Fail, complete: Complete, logger: logging.Logger): |
There was a problem hiding this comment.
🦠 praise: Thanks for catching this much!
| ------|------------ | ||
| `client` | A `WebClient` instance used to make things happen in Slack. From sending messages to opening modals, `client` makes it all happen. For a full list of available methods, refer to the [Web API methods](/reference/methods). Read more about the `WebClient` for Bolt Python [here](https://docs.slack.dev/tools/bolt-python/concepts/web-api/). | ||
| `complete` | A utility method that invokes `functions.completeSuccess`. This method indicates to Slack that a step has completed successfully without issue. When called, `complete` requires you include an `outputs` object that matches your step definition in [`output_parameters`](#inputs-outputs). | ||
| `complete` | A utility method that invokes `functions.completeSuccess`. This method indicates to Slack that a step has completed successfully without issue. When called, `complete` accepts an optional `outputs` object that matches your step definition in [`output_parameters`](#inputs-outputs). |
There was a problem hiding this comment.
🎁 praise: Thanks for catching this!
| # Updating & pushing views | ||
|
|
||
| Modals contain a stack of views. When you call [`views_open`](https://api./reference/methods/views.open/slack.com/methods/views.open), you add the root view to the modal. After the initial call, you can dynamically update a view by calling [`views_update`](/reference/methods/views.update/), or stack a new view on top of the root view by calling [`views_push`](/reference/methods/views.push/) | ||
| Modals contain a stack of views. When you call [`views_open`](/reference/methods/views.open/), you add the root view to the modal. After the initial call, you can dynamically update a view by calling [`views_update`](/reference/methods/views.update/), or stack a new view on top of the root view by calling [`views_push`](/reference/methods/views.push/) |
There was a problem hiding this comment.
📚 praise: Fast load good I think!
| stream.append(markdown_text="Hello!") | ||
| stream.stop() | ||
| ``` | ||
| There are currently no active experiments. We're steadily staying stable. |
3 participants
Summary
🤖 Generated with Claude Code
Audited
docs/english/for accuracy against the source code and fixed critical issues (syntax errors, non-existent APIs, wrong language commands).experiments.mdBoltAgent/AsyncBoltAgentfeature that never shipped; noted no active experimentsconcepts/view-submissions.mdexcept e:→except Exception as e:(SyntaxError)concepts/message-sending.mdsay_streamnull-condition wordingconcepts/adding-agent-features.mdawaitfrom syncdeffunctions (2 SyntaxErrors); fixedsay_streamnull-conditionconcepts/updating-pushing-views.mdviews_openURLconcepts/using-the-assistant-class.mdfind+savenotget+save;setTitle→set_title,setStatus→set_status; "array"→"list"tutorial/custom-steps.md{}→[]forrequired); added missingclientparam;completeoutputs are optionaltutorial/custom-steps-workflow-builder-new/npm install/npm start→ Python equivalentstutorial/custom-steps-workflow-builder-existing/package.json→requirements.txt; removed invalidmessage=param; fixed f-string syntax for Python <3.12