Skip to content

Commit 57d8dd6

Browse files
committed
Improve WebClient documents to be more robust
1 parent 8f65b94 commit 57d8dd6

2 files changed

Lines changed: 2 additions & 2 deletions

File tree

docs-src/web/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -607,7 +607,7 @@ This library covers all the public endpoints as the methods in ``WebClient``. Th
607607
client = WebClient(token=os.environ['SLACK_BOT_TOKEN'])
608608
response = client.api_call(
609609
api_method='chat.postMessage',
610-
json={'channel': '#random','text': "Hello world!"}
610+
params={'channel': '#random','text': "Hello world!"}
611611
)
612612
assert response["message"]["text"] == "Hello world!"
613613

docs/web/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -695,7 +695,7 @@ <h3>Calling any API methods<a class="headerlink" href="#calling-any-api-methods"
695695
<span class="n">client</span> <span class="o">=</span> <span class="n">WebClient</span><span class="p">(</span><span class="n">token</span><span class="o">=</span><span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s1">&#39;SLACK_BOT_TOKEN&#39;</span><span class="p">])</span>
696696
<span class="n">response</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">api_call</span><span class="p">(</span>
697697
<span class="n">api_method</span><span class="o">=</span><span class="s1">&#39;chat.postMessage&#39;</span><span class="p">,</span>
698-
<span class="n">json</span><span class="o">=</span><span class="p">{</span><span class="s1">&#39;channel&#39;</span><span class="p">:</span> <span class="s1">&#39;#random&#39;</span><span class="p">,</span><span class="s1">&#39;text&#39;</span><span class="p">:</span> <span class="s2">&quot;Hello world!&quot;</span><span class="p">}</span>
698+
<span class="n">params</span><span class="o">=</span><span class="p">{</span><span class="s1">&#39;channel&#39;</span><span class="p">:</span> <span class="s1">&#39;#random&#39;</span><span class="p">,</span><span class="s1">&#39;text&#39;</span><span class="p">:</span> <span class="s2">&quot;Hello world!&quot;</span><span class="p">}</span>
699699
<span class="p">)</span>
700700
<span class="k">assert</span> <span class="n">response</span><span class="p">[</span><span class="s2">&quot;message&quot;</span><span class="p">][</span><span class="s2">&quot;text&quot;</span><span class="p">]</span> <span class="o">==</span> <span class="s2">&quot;Hello world!&quot;</span>
701701
</pre></div>

0 commit comments

Comments
 (0)