adds docs

Author: lukegalbraithrussell

docs/reference/index.html

@@ -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.
+              with text and &#34;plan&#34; displays all tasks together.
             **kwargs: Additional arguments passed to the underlying API calls.
 
         Returns:
@@ -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:
@@ -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>

docs/reference/models/blocks/basic_components.html

@@ -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>
@@ -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>
@@ -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>
@@ -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>
@@ -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>
@@ -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>

docs/reference/models/blocks/block_elements.html

@@ -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>
@@ -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>
@@ -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">
@@ -4695,7 +4695,7 @@ <h3>Inherited members</h3>
         **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:
@@ -4711,7 +4711,7 @@ <h3>Inherited members</h3>
 </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>

docs/reference/models/blocks/blocks.html

@@ -298,13 +298,13 @@ <h3>Class variables</h3>
 <h3>Static methods</h3>
 <dl>
 <dt id="slack_sdk.models.blocks.blocks.Block.parse"><code class="name flex">
-<span>def <span class="ident">parse</span></span>(<span>block: dict | ForwardRef('<a title="slack_sdk.models.blocks.blocks.Block" href="#slack_sdk.models.blocks.blocks.Block">Block</a>')) ‑> <a title="slack_sdk.models.blocks.blocks.Block" href="#slack_sdk.models.blocks.blocks.Block">Block</a> | None</span>
+<span>def <span class="ident">parse</span></span>(<span>block: dict | <a title="slack_sdk.models.blocks.blocks.Block" href="#slack_sdk.models.blocks.blocks.Block">Block</a>) ‑> <a title="slack_sdk.models.blocks.blocks.Block" href="#slack_sdk.models.blocks.blocks.Block">Block</a> | None</span>
 </code></dt>
 <dd>
 <div class="desc"></div>
 </dd>
 <dt id="slack_sdk.models.blocks.blocks.Block.parse_all"><code class="name flex">
-<span>def <span class="ident">parse_all</span></span>(<span>blocks: Sequence[dict | ForwardRef('<a title="slack_sdk.models.blocks.blocks.Block" href="#slack_sdk.models.blocks.blocks.Block">Block</a>')] | None) ‑> List[<a title="slack_sdk.models.blocks.blocks.Block" href="#slack_sdk.models.blocks.blocks.Block">Block</a>]</span>
+<span>def <span class="ident">parse_all</span></span>(<span>blocks: Sequence[dict | <a title="slack_sdk.models.blocks.blocks.Block" href="#slack_sdk.models.blocks.blocks.Block">Block</a>] | None) ‑> List[<a title="slack_sdk.models.blocks.blocks.Block" href="#slack_sdk.models.blocks.blocks.Block">Block</a>]</span>
 </code></dt>
 <dd>
 <div class="desc"></div>
@@ -1358,7 +1358,7 @@ <h3>Inherited members</h3>
         block_id: Optional[str] = None,
         **others: dict,
     ):
-        &#34;&#34;&#34;A collection of related tasks.
+        &#34;&#34;&#34;Displays a collection of related tasks.
         https://docs.slack.dev/reference/block-kit/blocks/plan-block/
 
         Args:
@@ -1381,7 +1381,7 @@ <h3>Inherited members</h3>
 <div class="desc"><p>Blocks are a series of components that can be combined
 to create visually rich and compellingly interactive messages.
 <a href="https://docs.slack.dev/reference/block-kit/blocks">https://docs.slack.dev/reference/block-kit/blocks</a></p>
-<p>A collection of related tasks.
+<p>Displays a collection of related tasks.
 <a href="https://docs.slack.dev/reference/block-kit/blocks/plan-block/">https://docs.slack.dev/reference/block-kit/blocks/plan-block/</a></p>
 <h2 id="args">Args</h2>
 <dl>
@@ -1861,7 +1861,7 @@ <h3>Inherited members</h3>
         block_id: Optional[str] = None,
         **others: dict,
     ):
-        &#34;&#34;&#34;A discrete action or tool call.
+        &#34;&#34;&#34;Displays a single task, representing a single action.
         https://docs.slack.dev/reference/block-kit/blocks/task-card-block/
 
         Args:
@@ -1873,8 +1873,8 @@ <h3>Inherited members</h3>
             title (required): Title of the task in plain text
             details: Details of the task in the form of a single &#34;rich_text&#34; entity.
             output: Output of the task in the form of a single &#34;rich_text&#34; entity.
-            sources: List of sources used to generate a response
-            status: The state of a task. Either &#34;pending&#34; or &#34;in_progress&#34; or &#34;complete&#34; or &#34;error&#34;.
+            sources: Array of URL source elements used to generate a response.
+            status: The state of a task. Either &#34;pending&#34;, &#34;in_progress&#34;, &#34;complete&#34;, or &#34;error&#34;.
         &#34;&#34;&#34;
         super().__init__(type=self.type, block_id=block_id)
         show_unknown_key_warning(self, others)
@@ -1893,7 +1893,7 @@ <h3>Inherited members</h3>
 <div class="desc"><p>Blocks are a series of components that can be combined
 to create visually rich and compellingly interactive messages.
 <a href="https://docs.slack.dev/reference/block-kit/blocks">https://docs.slack.dev/reference/block-kit/blocks</a></p>
-<p>A discrete action or tool call.
+<p>Displays a single task, representing a single action.
 <a href="https://docs.slack.dev/reference/block-kit/blocks/task-card-block/">https://docs.slack.dev/reference/block-kit/blocks/task-card-block/</a></p>
 <h2 id="args">Args</h2>
 <dl>
@@ -1911,9 +1911,9 @@ <h2 id="args">Args</h2>
 <dt><strong><code>output</code></strong></dt>
 <dd>Output of the task in the form of a single "rich_text" entity.</dd>
 <dt><strong><code>sources</code></strong></dt>
-<dd>List of sources used to generate a response</dd>
+<dd>Array of URL source elements used to generate a response.</dd>
 <dt><strong><code>status</code></strong></dt>
-<dd>The state of a task. Either "pending" or "in_progress" or "complete" or "error".</dd>
+<dd>The state of a task. Either "pending", "in_progress", "complete", or "error".</dd>
 </dl></div>
 <h3>Ancestors</h3>
 <ul class="hlist">