Skip to content

docs: polishing source wording #1825

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mwbrooks merged 4 commits into from
Jan 30, 2026
Merged

docs: polishing source wording #1825

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fb1c49a
adds docs
lukegalbraithrussell Jan 29, 2026
732b325
Merge remote-tracking branch 'origin/feat-ai-apps-thinking-steps' int…
lukegalbraithrussell Jan 29, 2026
cbbeb96
plan chunk inclusion
lukegalbraithrussell Jan 30, 2026
7b17257
copy miss
lukegalbraithrussell Jan 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/reference/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3098,7 +3098,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
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 &#34;timeline&#34; displays individual tasks
interleaved with text and &#34;plan&#34; displays all tasks together.
Copy link
Contributor Author

@lukegalbraithrussell lukegalbraithrussell Jan 29, 2026

Choose a reason for hiding this comment

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

i didn't know this word so i'm assuming the average dev doesn't either

Copy link
Member

@mwbrooks mwbrooks Jan 30, 2026

Choose a reason for hiding this comment

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

I've heard it tossed around a few times lately and I also felt like I didn't quite know the definition.

with text and &#34;plan&#34; displays all tasks together.
**kwargs: Additional arguments passed to the underlying API calls.

Returns:
Expand Down Expand Up @@ -10738,7 +10738,7 @@ <h3>Methods</h3>
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 &#34;timeline&#34; displays individual tasks
interleaved with text and &#34;plan&#34; displays all tasks together.
with text and &#34;plan&#34; displays all tasks together.
**kwargs: Additional arguments passed to the underlying API calls.

Returns:
Expand Down Expand Up @@ -10799,7 +10799,7 @@ <h2 id="args">Args</h2>
<dd>The encoded ID of the user to receive the streaming text. Required when streaming to channels.</dd>
<dt><strong><code>task_display_mode</code></strong></dt>
<dd>Specifies how tasks are displayed in the message. A "timeline" displays individual tasks
interleaved with text and "plan" displays all tasks together.</dd>
with text and "plan" displays all tasks together.</dd>
<dt><strong><code>**kwargs</code></strong></dt>
<dd>Additional arguments passed to the underlying API calls.</dd>
</dl>
Expand Down
12 changes: 6 additions & 6 deletions docs/reference/models/blocks/basic_components.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,7 @@ <h3>Class variables</h3>
<h3>Static methods</h3>
<dl>
<dt id="slack_sdk.models.blocks.basic_components.ConfirmObject.parse"><code class="name flex">
<span>def <span class="ident">parse</span></span>(<span>confirm: ForwardRef('<a title="slack_sdk.models.blocks.basic_components.ConfirmObject" href="#slack_sdk.models.blocks.basic_components.ConfirmObject">ConfirmObject</a>') | Dict[str, Any])</span>
<span>def <span class="ident">parse</span></span>(<span>confirm: <a title="slack_sdk.models.blocks.basic_components.ConfirmObject" href="#slack_sdk.models.blocks.basic_components.ConfirmObject">ConfirmObject</a> | Dict[str, Any])</span>
</code></dt>
<dd>
<div class="desc"></div>
Expand Down Expand Up @@ -324,7 +324,7 @@ <h3>Class variables</h3>
<h3>Static methods</h3>
<dl>
<dt id="slack_sdk.models.blocks.basic_components.DispatchActionConfig.parse"><code class="name flex">
<span>def <span class="ident">parse</span></span>(<span>config: ForwardRef('<a title="slack_sdk.models.blocks.basic_components.DispatchActionConfig" href="#slack_sdk.models.blocks.basic_components.DispatchActionConfig">DispatchActionConfig</a>') | Dict[str, Any])</span>
<span>def <span class="ident">parse</span></span>(<span>config: <a title="slack_sdk.models.blocks.basic_components.DispatchActionConfig" href="#slack_sdk.models.blocks.basic_components.DispatchActionConfig">DispatchActionConfig</a> | Dict[str, Any])</span>
</code></dt>
<dd>
<div class="desc"></div>
Expand Down Expand Up @@ -446,7 +446,7 @@ <h3>Class variables</h3>
<h3>Static methods</h3>
<dl>
<dt id="slack_sdk.models.blocks.basic_components.FeedbackButtonObject.parse"><code class="name flex">
<span>def <span class="ident">parse</span></span>(<span>feedback_button: ForwardRef('<a title="slack_sdk.models.blocks.basic_components.FeedbackButtonObject" href="#slack_sdk.models.blocks.basic_components.FeedbackButtonObject">FeedbackButtonObject</a>') | Dict[str, Any])</span>
<span>def <span class="ident">parse</span></span>(<span>feedback_button: <a title="slack_sdk.models.blocks.basic_components.FeedbackButtonObject" href="#slack_sdk.models.blocks.basic_components.FeedbackButtonObject">FeedbackButtonObject</a> | Dict[str, Any])</span>
</code></dt>
<dd>
<div class="desc"></div>
Expand Down Expand Up @@ -907,7 +907,7 @@ <h3>Static methods</h3>
<div class="desc"><p>Creates a simple Option instance with the same value and label</p></div>
</dd>
<dt id="slack_sdk.models.blocks.basic_components.Option.parse_all"><code class="name flex">
<span>def <span class="ident">parse_all</span></span>(<span>options: Sequence[Dict[str, Any] | ForwardRef('<a title="slack_sdk.models.blocks.basic_components.Option" href="#slack_sdk.models.blocks.basic_components.Option">Option</a>')] | None) ‑> List[<a title="slack_sdk.models.blocks.basic_components.Option" href="#slack_sdk.models.blocks.basic_components.Option">Option</a>] | None</span>
<span>def <span class="ident">parse_all</span></span>(<span>options: Sequence[Dict[str, Any] | <a title="slack_sdk.models.blocks.basic_components.Option" href="#slack_sdk.models.blocks.basic_components.Option">Option</a>] | None) ‑> List[<a title="slack_sdk.models.blocks.basic_components.Option" href="#slack_sdk.models.blocks.basic_components.Option">Option</a>] | None</span>
</code></dt>
<dd>
<div class="desc"></div>
Expand Down Expand Up @@ -1105,7 +1105,7 @@ <h3>Class variables</h3>
<h3>Static methods</h3>
<dl>
<dt id="slack_sdk.models.blocks.basic_components.OptionGroup.parse_all"><code class="name flex">
<span>def <span class="ident">parse_all</span></span>(<span>option_groups: Sequence[Dict[str, Any] | ForwardRef('<a title="slack_sdk.models.blocks.basic_components.OptionGroup" href="#slack_sdk.models.blocks.basic_components.OptionGroup">OptionGroup</a>')] | None) ‑> List[<a title="slack_sdk.models.blocks.basic_components.OptionGroup" href="#slack_sdk.models.blocks.basic_components.OptionGroup">OptionGroup</a>] | None</span>
<span>def <span class="ident">parse_all</span></span>(<span>option_groups: Sequence[Dict[str, Any] | <a title="slack_sdk.models.blocks.basic_components.OptionGroup" href="#slack_sdk.models.blocks.basic_components.OptionGroup">OptionGroup</a>] | None) ‑> List[<a title="slack_sdk.models.blocks.basic_components.OptionGroup" href="#slack_sdk.models.blocks.basic_components.OptionGroup">OptionGroup</a>] | None</span>
</code></dt>
<dd>
<div class="desc"></div>
Expand Down Expand Up @@ -1536,7 +1536,7 @@ <h3>Class variables</h3>
<h3>Static methods</h3>
<dl>
<dt id="slack_sdk.models.blocks.basic_components.TextObject.parse"><code class="name flex">
<span>def <span class="ident">parse</span></span>(<span>text: str | Dict[str, Any] | ForwardRef('<a title="slack_sdk.models.blocks.basic_components.TextObject" href="#slack_sdk.models.blocks.basic_components.TextObject">TextObject</a>'),<br>default_type: str = 'mrkdwn') ‑> <a title="slack_sdk.models.blocks.basic_components.TextObject" href="#slack_sdk.models.blocks.basic_components.TextObject">TextObject</a> | None</span>
<span>def <span class="ident">parse</span></span>(<span>text: str | Dict[str, Any] | <a title="slack_sdk.models.blocks.basic_components.TextObject" href="#slack_sdk.models.blocks.basic_components.TextObject">TextObject</a>,<br>default_type: str = 'mrkdwn') ‑> <a title="slack_sdk.models.blocks.basic_components.TextObject" href="#slack_sdk.models.blocks.basic_components.TextObject">TextObject</a> | None</span>
</code></dt>
<dd>
<div class="desc"></div>
Expand Down
23 changes: 8 additions & 15 deletions docs/reference/models/blocks/block_elements.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,13 +146,13 @@ <h3>Class variables</h3>
<h3>Static methods</h3>
<dl>
<dt id="slack_sdk.models.blocks.block_elements.BlockElement.parse"><code class="name flex">
<span>def <span class="ident">parse</span></span>(<span>block_element: dict | ForwardRef('<a title="slack_sdk.models.blocks.block_elements.BlockElement" href="#slack_sdk.models.blocks.block_elements.BlockElement">BlockElement</a>')) ‑> <a title="slack_sdk.models.blocks.block_elements.BlockElement" href="#slack_sdk.models.blocks.block_elements.BlockElement">BlockElement</a> | <a title="slack_sdk.models.blocks.basic_components.TextObject" href="basic_components.html#slack_sdk.models.blocks.basic_components.TextObject">TextObject</a> | None</span>
<span>def <span class="ident">parse</span></span>(<span>block_element: dict | <a title="slack_sdk.models.blocks.block_elements.BlockElement" href="#slack_sdk.models.blocks.block_elements.BlockElement">BlockElement</a>) ‑> <a title="slack_sdk.models.blocks.block_elements.BlockElement" href="#slack_sdk.models.blocks.block_elements.BlockElement">BlockElement</a> | <a title="slack_sdk.models.blocks.basic_components.TextObject" href="basic_components.html#slack_sdk.models.blocks.basic_components.TextObject">TextObject</a> | None</span>
</code></dt>
<dd>
<div class="desc"></div>
</dd>
<dt id="slack_sdk.models.blocks.block_elements.BlockElement.parse_all"><code class="name flex">
<span>def <span class="ident">parse_all</span></span>(<span>block_elements: Sequence[dict | ForwardRef('<a title="slack_sdk.models.blocks.block_elements.BlockElement" href="#slack_sdk.models.blocks.block_elements.BlockElement">BlockElement</a>') | <a title="slack_sdk.models.blocks.basic_components.TextObject" href="basic_components.html#slack_sdk.models.blocks.basic_components.TextObject">TextObject</a>]) ‑> List[<a title="slack_sdk.models.blocks.block_elements.BlockElement" href="#slack_sdk.models.blocks.block_elements.BlockElement">BlockElement</a> | <a title="slack_sdk.models.blocks.basic_components.TextObject" href="basic_components.html#slack_sdk.models.blocks.basic_components.TextObject">TextObject</a>]</span>
<span>def <span class="ident">parse_all</span></span>(<span>block_elements: Sequence[dict | <a title="slack_sdk.models.blocks.block_elements.BlockElement" href="#slack_sdk.models.blocks.block_elements.BlockElement">BlockElement</a> | <a title="slack_sdk.models.blocks.basic_components.TextObject" href="basic_components.html#slack_sdk.models.blocks.basic_components.TextObject">TextObject</a>]) ‑> List[<a title="slack_sdk.models.blocks.block_elements.BlockElement" href="#slack_sdk.models.blocks.block_elements.BlockElement">BlockElement</a> | <a title="slack_sdk.models.blocks.basic_components.TextObject" href="basic_components.html#slack_sdk.models.blocks.basic_components.TextObject">TextObject</a>]</span>
</code></dt>
<dd>
<div class="desc"></div>
Expand Down Expand Up @@ -829,7 +829,7 @@ <h3>Class variables</h3>
<h3>Static methods</h3>
<dl>
<dt id="slack_sdk.models.blocks.block_elements.ConversationFilter.parse"><code class="name flex">
<span>def <span class="ident">parse</span></span>(<span>filter: dict | ForwardRef('<a title="slack_sdk.models.blocks.block_elements.ConversationFilter" href="#slack_sdk.models.blocks.block_elements.ConversationFilter">ConversationFilter</a>'))</span>
<span>def <span class="ident">parse</span></span>(<span>filter: dict | <a title="slack_sdk.models.blocks.block_elements.ConversationFilter" href="#slack_sdk.models.blocks.block_elements.ConversationFilter">ConversationFilter</a>)</span>
</code></dt>
<dd>
<div class="desc"></div>
Expand Down Expand Up @@ -3505,7 +3505,7 @@ <h3>Class variables</h3>
</dd>
<dt id="slack_sdk.models.blocks.block_elements.RichTextInputElement"><code class="flex name class">
<span>class <span class="ident">RichTextInputElement</span></span>
<span>(</span><span>*,<br>action_id: str | None = None,<br>placeholder: str | dict | <a title="slack_sdk.models.blocks.basic_components.TextObject" href="basic_components.html#slack_sdk.models.blocks.basic_components.TextObject">TextObject</a> | None = None,<br>initial_value: Dict[str, Any] | ForwardRef('RichTextBlock') | None = None,<br>dispatch_action_config: dict | <a title="slack_sdk.models.blocks.basic_components.DispatchActionConfig" href="basic_components.html#slack_sdk.models.blocks.basic_components.DispatchActionConfig">DispatchActionConfig</a> | None = None,<br>focus_on_load: bool | None = None,<br>**others: dict)</span>
<span>(</span><span>*,<br>action_id: str | None = None,<br>placeholder: str | dict | <a title="slack_sdk.models.blocks.basic_components.TextObject" href="basic_components.html#slack_sdk.models.blocks.basic_components.TextObject">TextObject</a> | None = None,<br>initial_value: Dict[str, Any] | RichTextBlock | None = None,<br>dispatch_action_config: dict | <a title="slack_sdk.models.blocks.basic_components.DispatchActionConfig" href="basic_components.html#slack_sdk.models.blocks.basic_components.DispatchActionConfig">DispatchActionConfig</a> | None = None,<br>focus_on_load: bool | None = None,<br>**others: dict)</span>
</code></dt>
<dd>
<details class="source">
Expand Down Expand Up @@ -4666,7 +4666,7 @@ <h3>Inherited members</h3>
</dd>
<dt id="slack_sdk.models.blocks.block_elements.UrlSourceElement"><code class="flex name class">
<span>class <span class="ident">UrlSourceElement</span></span>
<span>(</span><span>*, url: str, text: str, icon_url: str | None = None, **others: Dict)</span>
<span>(</span><span>*, url: str, text: str, **others: Dict)</span>
</code></dt>
<dd>
<details class="source">
Expand All @@ -4682,7 +4682,6 @@ <h3>Inherited members</h3>
{
&#34;url&#34;,
&#34;text&#34;,
&#34;icon_url&#34;,
}
)

Expand All @@ -4691,36 +4690,31 @@ <h3>Inherited members</h3>
*,
url: str,
text: str,
icon_url: Optional[str] = None,
**others: Dict,
):
&#34;&#34;&#34;
A URL source element to reference in a task card block.
A URL source element that displays a URL source for referencing within a task card block.
https://docs.slack.dev/reference/block-kit/block-elements/url-source-element

Args:
url (required): The URL type source.
text (required): Display text for the URL.
icon_url: Optional icon URL to display with the source.
&#34;&#34;&#34;
super().__init__(type=self.type)
show_unknown_key_warning(self, others)
self.url = url
self.text = text
self.icon_url = icon_url</code></pre>
self.text = text</code></pre>
</details>
<div class="desc"><p>Block Elements are things that exists inside of your Blocks.
<a href="https://docs.slack.dev/reference/block-kit/block-elements/">https://docs.slack.dev/reference/block-kit/block-elements/</a></p>
<p>A URL source element to reference in a task card block.
<p>A URL source element that displays a URL source for referencing within a task card block.
<a href="https://docs.slack.dev/reference/block-kit/block-elements/url-source-element">https://docs.slack.dev/reference/block-kit/block-elements/url-source-element</a></p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>url</code></strong> :&ensp;<code>required</code></dt>
<dd>The URL type source.</dd>
<dt><strong><code>text</code></strong> :&ensp;<code>required</code></dt>
<dd>Display text for the URL.</dd>
<dt><strong><code>icon_url</code></strong></dt>
<dd>Optional icon URL to display with the source.</dd>
</dl></div>
<h3>Ancestors</h3>
<ul class="hlist">
Expand Down Expand Up @@ -4749,7 +4743,6 @@ <h3>Instance variables</h3>
{
&#34;url&#34;,
&#34;text&#34;,
&#34;icon_url&#34;,
}
)</code></pre>
</details>
Expand Down
Loading