Skip to content

Commit 6ae339f

Browse files
docs: polishing source wording (#1825)
1 parent 83bc1e8 commit 6ae339f

File tree

19 files changed

+110
-142
lines changed

19 files changed

+110
-142
lines changed

docs/reference/index.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3098,7 +3098,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
30983098
streaming to channels.
30993099
recipient_user_id: The encoded ID of the user to receive the streaming text. Required when streaming to channels.
31003100
task_display_mode: Specifies how tasks are displayed in the message. A &#34;timeline&#34; displays individual tasks
3101-
interleaved with text and &#34;plan&#34; displays all tasks together.
3101+
with text and &#34;plan&#34; displays all tasks together.
31023102
**kwargs: Additional arguments passed to the underlying API calls.
31033103

31043104
Returns:
@@ -10738,7 +10738,7 @@ <h3>Methods</h3>
1073810738
streaming to channels.
1073910739
recipient_user_id: The encoded ID of the user to receive the streaming text. Required when streaming to channels.
1074010740
task_display_mode: Specifies how tasks are displayed in the message. A &#34;timeline&#34; displays individual tasks
10741-
interleaved with text and &#34;plan&#34; displays all tasks together.
10741+
with text and &#34;plan&#34; displays all tasks together.
1074210742
**kwargs: Additional arguments passed to the underlying API calls.
1074310743

1074410744
Returns:
@@ -10799,7 +10799,7 @@ <h2 id="args">Args</h2>
1079910799
<dd>The encoded ID of the user to receive the streaming text. Required when streaming to channels.</dd>
1080010800
<dt><strong><code>task_display_mode</code></strong></dt>
1080110801
<dd>Specifies how tasks are displayed in the message. A "timeline" displays individual tasks
10802-
interleaved with text and "plan" displays all tasks together.</dd>
10802+
with text and "plan" displays all tasks together.</dd>
1080310803
<dt><strong><code>**kwargs</code></strong></dt>
1080410804
<dd>Additional arguments passed to the underlying API calls.</dd>
1080510805
</dl>

docs/reference/models/blocks/basic_components.html

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -188,7 +188,7 @@ <h3>Class variables</h3>
188188
<h3>Static methods</h3>
189189
<dl>
190190
<dt id="slack_sdk.models.blocks.basic_components.ConfirmObject.parse"><code class="name flex">
191-
<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>
191+
<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>
192192
</code></dt>
193193
<dd>
194194
<div class="desc"></div>
@@ -324,7 +324,7 @@ <h3>Class variables</h3>
324324
<h3>Static methods</h3>
325325
<dl>
326326
<dt id="slack_sdk.models.blocks.basic_components.DispatchActionConfig.parse"><code class="name flex">
327-
<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>
327+
<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>
328328
</code></dt>
329329
<dd>
330330
<div class="desc"></div>
@@ -446,7 +446,7 @@ <h3>Class variables</h3>
446446
<h3>Static methods</h3>
447447
<dl>
448448
<dt id="slack_sdk.models.blocks.basic_components.FeedbackButtonObject.parse"><code class="name flex">
449-
<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>
449+
<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>
450450
</code></dt>
451451
<dd>
452452
<div class="desc"></div>
@@ -907,7 +907,7 @@ <h3>Static methods</h3>
907907
<div class="desc"><p>Creates a simple Option instance with the same value and label</p></div>
908908
</dd>
909909
<dt id="slack_sdk.models.blocks.basic_components.Option.parse_all"><code class="name flex">
910-
<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>
910+
<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>
911911
</code></dt>
912912
<dd>
913913
<div class="desc"></div>
@@ -1105,7 +1105,7 @@ <h3>Class variables</h3>
11051105
<h3>Static methods</h3>
11061106
<dl>
11071107
<dt id="slack_sdk.models.blocks.basic_components.OptionGroup.parse_all"><code class="name flex">
1108-
<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>
1108+
<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>
11091109
</code></dt>
11101110
<dd>
11111111
<div class="desc"></div>
@@ -1536,7 +1536,7 @@ <h3>Class variables</h3>
15361536
<h3>Static methods</h3>
15371537
<dl>
15381538
<dt id="slack_sdk.models.blocks.basic_components.TextObject.parse"><code class="name flex">
1539-
<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>
1539+
<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>
15401540
</code></dt>
15411541
<dd>
15421542
<div class="desc"></div>

docs/reference/models/blocks/block_elements.html

Lines changed: 8 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -146,13 +146,13 @@ <h3>Class variables</h3>
146146
<h3>Static methods</h3>
147147
<dl>
148148
<dt id="slack_sdk.models.blocks.block_elements.BlockElement.parse"><code class="name flex">
149-
<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>
149+
<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>
150150
</code></dt>
151151
<dd>
152152
<div class="desc"></div>
153153
</dd>
154154
<dt id="slack_sdk.models.blocks.block_elements.BlockElement.parse_all"><code class="name flex">
155-
<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>
155+
<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>
156156
</code></dt>
157157
<dd>
158158
<div class="desc"></div>
@@ -829,7 +829,7 @@ <h3>Class variables</h3>
829829
<h3>Static methods</h3>
830830
<dl>
831831
<dt id="slack_sdk.models.blocks.block_elements.ConversationFilter.parse"><code class="name flex">
832-
<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>
832+
<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>
833833
</code></dt>
834834
<dd>
835835
<div class="desc"></div>
@@ -3505,7 +3505,7 @@ <h3>Class variables</h3>
35053505
</dd>
35063506
<dt id="slack_sdk.models.blocks.block_elements.RichTextInputElement"><code class="flex name class">
35073507
<span>class <span class="ident">RichTextInputElement</span></span>
3508-
<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>
3508+
<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>
35093509
</code></dt>
35103510
<dd>
35113511
<details class="source">
@@ -4666,7 +4666,7 @@ <h3>Inherited members</h3>
46664666
</dd>
46674667
<dt id="slack_sdk.models.blocks.block_elements.UrlSourceElement"><code class="flex name class">
46684668
<span>class <span class="ident">UrlSourceElement</span></span>
4669-
<span>(</span><span>*, url: str, text: str, icon_url: str | None = None, **others: Dict)</span>
4669+
<span>(</span><span>*, url: str, text: str, **others: Dict)</span>
46704670
</code></dt>
46714671
<dd>
46724672
<details class="source">
@@ -4682,7 +4682,6 @@ <h3>Inherited members</h3>
46824682
{
46834683
&#34;url&#34;,
46844684
&#34;text&#34;,
4685-
&#34;icon_url&#34;,
46864685
}
46874686
)
46884687

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

47014699
Args:
47024700
url (required): The URL type source.
47034701
text (required): Display text for the URL.
4704-
icon_url: Optional icon URL to display with the source.
47054702
&#34;&#34;&#34;
47064703
super().__init__(type=self.type)
47074704
show_unknown_key_warning(self, others)
47084705
self.url = url
4709-
self.text = text
4710-
self.icon_url = icon_url</code></pre>
4706+
self.text = text</code></pre>
47114707
</details>
47124708
<div class="desc"><p>Block Elements are things that exists inside of your Blocks.
47134709
<a href="https://docs.slack.dev/reference/block-kit/block-elements/">https://docs.slack.dev/reference/block-kit/block-elements/</a></p>
4714-
<p>A URL source element to reference in a task card block.
4710+
<p>A URL source element that displays a URL source for referencing within a task card block.
47154711
<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>
47164712
<h2 id="args">Args</h2>
47174713
<dl>
47184714
<dt><strong><code>url</code></strong> :&ensp;<code>required</code></dt>
47194715
<dd>The URL type source.</dd>
47204716
<dt><strong><code>text</code></strong> :&ensp;<code>required</code></dt>
47214717
<dd>Display text for the URL.</dd>
4722-
<dt><strong><code>icon_url</code></strong></dt>
4723-
<dd>Optional icon URL to display with the source.</dd>
47244718
</dl></div>
47254719
<h3>Ancestors</h3>
47264720
<ul class="hlist">
@@ -4749,7 +4743,6 @@ <h3>Instance variables</h3>
47494743
{
47504744
&#34;url&#34;,
47514745
&#34;text&#34;,
4752-
&#34;icon_url&#34;,
47534746
}
47544747
)</code></pre>
47554748
</details>

0 commit comments

Comments
 (0)