Update site from docs source repo

Author: Exploding Labs Bot

jsonrpcclient/requests/index.html

@@ -567,58 +567,63 @@
 <h1 id="generating-requests">Generating requests</h1>
 <h2 id="the-request-function">The request function</h2>
 <p>Generate a request with the <code>request</code> function:</p>
-<div class="highlight"><pre><span></span><code><span class="o">&gt;&gt;&gt;</span> <span class="kn">from</span><span class="w"> </span><span class="nn">jsonrpcclient</span><span class="w"> </span><span class="kn">import</span> <span class="n">request</span>
+<div class="highlight"><pre><span></span><code><span class="o">&gt;&gt;&gt;</span> <span class="kn">from</span><span class="w"> </span><span class="nn">jsonrpcclient</span><span class="w"> </span><span class="kn">import</span> <span class="n">request</span><span class="p">,</span> <span class="n">request_json</span>
 <span class="o">&gt;&gt;&gt;</span> <span class="n">request</span><span class="p">(</span><span class="s2">&quot;ping&quot;</span><span class="p">)</span>
-<span class="p">{</span><span class="s2">&quot;jsonrpc&quot;</span><span class="p">:</span> <span class="s2">&quot;2.0&quot;</span><span class="p">,</span> <span class="s2">&quot;method&quot;</span><span class="p">:</span> <span class="s2">&quot;ping&quot;</span><span class="p">,</span> <span class="s2">&quot;2.0&quot;</span><span class="p">,</span> <span class="s2">&quot;id&quot;</span><span class="p">:</span> <span class="mi">1</span><span class="p">}</span>
+<span class="p">{</span><span class="s1">&#39;jsonrpc&#39;</span><span class="p">:</span> <span class="s1">&#39;2.0&#39;</span><span class="p">,</span> <span class="s1">&#39;method&#39;</span><span class="p">:</span> <span class="s1">&#39;ping&#39;</span><span class="p">,</span> <span class="s1">&#39;id&#39;</span><span class="p">:</span> <span class="mi">1</span><span class="p">}</span>
 </code></pre></div>
+<p><code>request_json</code> gives you a string:</p>
+<div class="highlight"><pre><span></span><code><span class="o">&gt;&gt;&gt;</span> <span class="n">request_json</span><span class="p">(</span><span class="s2">&quot;ping&quot;</span><span class="p">)</span>
+<span class="s1">&#39;{&quot;jsonrpc&quot;: &quot;2.0&quot;, &quot;method&quot;: &quot;ping&quot;, &quot;id&quot;: 2}&#39;</span>
+</code></pre></div>
+<p>It simply applies <code>str</code> after <code>request</code>.</p>
 <h2 id="ids">Ids</h2>
-<p>Subsequent calls increment the <code>id</code>:
-<div class="highlight"><pre><span></span><code>&gt;&gt;&gt; request(&quot;ping&quot;)
-{&quot;jsonrpc&quot;: &quot;2.0&quot;, &quot;method&quot;: &quot;ping&quot;, &quot;2.0&quot;, &quot;id&quot;: 2}
-&gt;&gt;&gt; request(&quot;ping&quot;)
-{&quot;jsonrpc&quot;: &quot;2.0&quot;, &quot;method&quot;: &quot;ping&quot;, &quot;2.0&quot;, &quot;id&quot;: 3}
-</code></pre></div></p>
-<p>Use an explicit <code>id</code>:
-<div class="highlight"><pre><span></span><code>&gt;&gt;&gt; request(&quot;ping&quot;, id=&quot;foo&quot;)
-{&quot;jsonrpc&quot;: &quot;2.0&quot;, &quot;method&quot;: &quot;ping&quot;, &quot;2.0&quot;, &quot;id&quot;: &quot;foo&quot;}
-</code></pre></div></p>
-<p>Or generate a different type of <code>id</code>:
+<p>Subsequent calls increment the <code>id</code>:</p>
+<div class="highlight"><pre><span></span><code>&gt; &gt; &gt; request(&quot;ping&quot;)
+&gt; &gt; &gt; {&quot;jsonrpc&quot;: &quot;2.0&quot;, &quot;method&quot;: &quot;ping&quot;, &quot;2.0&quot;, &quot;id&quot;: 3}
+&gt; &gt; &gt; request(&quot;ping&quot;)
+&gt; &gt; &gt; {&quot;jsonrpc&quot;: &quot;2.0&quot;, &quot;method&quot;: &quot;ping&quot;, &quot;2.0&quot;, &quot;id&quot;: 4}
+</code></pre></div>
+<p>Use an explicit <code>id</code>:</p>
+<div class="highlight"><pre><span></span><code>&gt; &gt; &gt; request(&quot;ping&quot;, id=&quot;foo&quot;)
+&gt; &gt; &gt; {&quot;jsonrpc&quot;: &quot;2.0&quot;, &quot;method&quot;: &quot;ping&quot;, &quot;2.0&quot;, &quot;id&quot;: &quot;foo&quot;}
+</code></pre></div>
+<p>Or generate a different type of <code>id</code>:</p>
 <div class="highlight"><pre><span></span><code><span class="o">&gt;&gt;&gt;</span> <span class="kn">from</span><span class="w"> </span><span class="nn">jsonrpcclient</span><span class="w"> </span><span class="kn">import</span> <span class="n">request_hex</span><span class="p">,</span> <span class="n">request_random</span><span class="p">,</span> <span class="n">request_uuid</span>
 <span class="o">&gt;&gt;&gt;</span> <span class="n">request_hex</span><span class="p">(</span><span class="s2">&quot;foo&quot;</span><span class="p">)</span>
 <span class="p">{</span><span class="s2">&quot;jsonrpc&quot;</span><span class="p">:</span> <span class="s2">&quot;2.0&quot;</span><span class="p">,</span> <span class="s2">&quot;method&quot;</span><span class="p">:</span> <span class="s2">&quot;foo&quot;</span><span class="p">,</span> <span class="s2">&quot;id&quot;</span><span class="p">:</span> <span class="s2">&quot;1&quot;</span><span class="p">}</span>
 <span class="o">&gt;&gt;&gt;</span> <span class="n">request_random</span><span class="p">(</span><span class="s2">&quot;foo&quot;</span><span class="p">)</span>
 <span class="p">{</span><span class="s2">&quot;jsonrpc&quot;</span><span class="p">:</span> <span class="s2">&quot;2.0&quot;</span><span class="p">,</span> <span class="s2">&quot;method&quot;</span><span class="p">:</span> <span class="s2">&quot;foo&quot;</span><span class="p">,</span> <span class="s2">&quot;id&quot;</span><span class="p">:</span> <span class="s2">&quot;qzsib147&quot;</span><span class="p">}</span>
 <span class="o">&gt;&gt;&gt;</span> <span class="n">request_uuid</span><span class="p">(</span><span class="s2">&quot;foo&quot;</span><span class="p">)</span>
 <span class="p">{</span><span class="s2">&quot;jsonrpc&quot;</span><span class="p">:</span> <span class="s2">&quot;2.0&quot;</span><span class="p">,</span> <span class="s2">&quot;method&quot;</span><span class="p">:</span> <span class="s2">&quot;foo&quot;</span><span class="p">,</span> <span class="s2">&quot;id&quot;</span><span class="p">:</span> <span class="s2">&quot;45480a2f-069c-42aa-a67f-f6fdd83d6026&quot;</span><span class="p">}</span>
-</code></pre></div></p>
+</code></pre></div>
 <h2 id="parameters">Parameters</h2>
 <p>Pass <code>params</code> to include parameters in the payload. This should be either a
 tuple for positional arguments, or dict for keyword arguments.</p>
 <div class="highlight"><pre><span></span><code><span class="o">&gt;&gt;&gt;</span> <span class="n">request</span><span class="p">(</span><span class="s2">&quot;ping&quot;</span><span class="p">,</span> <span class="n">params</span><span class="o">=</span><span class="p">(</span><span class="mi">1</span><span class="p">,))</span>
-<span class="p">{</span><span class="s2">&quot;jsonrpc&quot;</span><span class="p">:</span> <span class="s2">&quot;2.0&quot;</span><span class="p">,</span> <span class="s2">&quot;method&quot;</span><span class="p">:</span> <span class="s2">&quot;ping&quot;</span><span class="p">,</span> <span class="s2">&quot;2.0&quot;</span><span class="p">,</span> <span class="s2">&quot;params&quot;</span><span class="p">:</span> <span class="p">[</span><span class="mi">1</span><span class="p">],</span> <span class="s2">&quot;id&quot;</span><span class="p">:</span> <span class="mi">4</span><span class="p">}</span>
+<span class="p">{</span><span class="s2">&quot;jsonrpc&quot;</span><span class="p">:</span> <span class="s2">&quot;2.0&quot;</span><span class="p">,</span> <span class="s2">&quot;method&quot;</span><span class="p">:</span> <span class="s2">&quot;ping&quot;</span><span class="p">,</span> <span class="s2">&quot;2.0&quot;</span><span class="p">,</span> <span class="s2">&quot;params&quot;</span><span class="p">:</span> <span class="p">[</span><span class="mi">1</span><span class="p">],</span> <span class="s2">&quot;id&quot;</span><span class="p">:</span> <span class="mi">5</span><span class="p">}</span>
 <span class="o">&gt;&gt;&gt;</span> <span class="n">request</span><span class="p">(</span><span class="s2">&quot;ping&quot;</span><span class="p">,</span> <span class="n">params</span><span class="o">=</span><span class="p">{</span><span class="s2">&quot;key&quot;</span><span class="p">:</span> <span class="s2">&quot;val&quot;</span><span class="p">})</span>
-<span class="p">{</span><span class="s2">&quot;jsonrpc&quot;</span><span class="p">:</span> <span class="s2">&quot;2.0&quot;</span><span class="p">,</span> <span class="s2">&quot;method&quot;</span><span class="p">:</span> <span class="s2">&quot;ping&quot;</span><span class="p">,</span> <span class="s2">&quot;2.0&quot;</span><span class="p">,</span> <span class="s2">&quot;params&quot;</span><span class="p">:</span> <span class="p">{</span><span class="s2">&quot;key&quot;</span><span class="p">:</span> <span class="s2">&quot;val&quot;</span><span class="p">},</span> <span class="s2">&quot;id&quot;</span><span class="p">:</span> <span class="mi">5</span><span class="p">}</span>
+<span class="p">{</span><span class="s2">&quot;jsonrpc&quot;</span><span class="p">:</span> <span class="s2">&quot;2.0&quot;</span><span class="p">,</span> <span class="s2">&quot;method&quot;</span><span class="p">:</span> <span class="s2">&quot;ping&quot;</span><span class="p">,</span> <span class="s2">&quot;2.0&quot;</span><span class="p">,</span> <span class="s2">&quot;params&quot;</span><span class="p">:</span> <span class="p">{</span><span class="s2">&quot;key&quot;</span><span class="p">:</span> <span class="s2">&quot;val&quot;</span><span class="p">},</span> <span class="s2">&quot;id&quot;</span><span class="p">:</span> <span class="mi">6</span><span class="p">}</span>
 </code></pre></div>
 <h2 id="json-requests">JSON requests</h2>
-<p>If you need the request serialized to a string, use <code>request_json</code>:
+<p>If you need the request serialized to a string, use <code>request_json</code>:</p>
 <div class="highlight"><pre><span></span><code><span class="o">&gt;&gt;&gt;</span> <span class="kn">from</span><span class="w"> </span><span class="nn">jsonrpcclient</span><span class="w"> </span><span class="kn">import</span> <span class="n">request_json</span>
 <span class="o">&gt;&gt;&gt;</span> <span class="n">request_json</span><span class="p">(</span><span class="s2">&quot;foo&quot;</span><span class="p">)</span>
 <span class="s1">&#39;{&quot;jsonrpc&quot;: &quot;2.0&quot;, &quot;method&quot;: &quot;foo&quot;, &quot;id&quot;: 6}&#39;</span>
-</code></pre></div></p>
+</code></pre></div>
 <p>You can also use request_json_hex etc., for the other id types.</p>
 <h2 id="batch-requests">Batch requests</h2>
 <div class="highlight"><pre><span></span><code><span class="o">&gt;&gt;&gt;</span> <span class="kn">import</span><span class="w"> </span><span class="nn">json</span>
 <span class="o">&gt;&gt;&gt;</span> <span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">([</span><span class="n">request</span><span class="p">(</span><span class="s2">&quot;foo&quot;</span><span class="p">)</span> <span class="k">for</span> <span class="n">_</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">3</span><span class="p">)])</span>
 <span class="s1">&#39;[{&quot;jsonrpc&quot;: &quot;2.0&quot;, &quot;method&quot;: &quot;foo&quot;, &quot;id&quot;: 7}, {&quot;jsonrpc&quot;: &quot;2.0&quot;, &quot;method&quot;: &quot;foo&quot;, &quot;id&quot;: 8}, {&quot;jsonrpc&quot;: &quot;2.0&quot;, &quot;method&quot;: &quot;foo&quot;, &quot;id&quot;: 9}]&#39;</span>
 </code></pre></div>
 <h2 id="notifications">Notifications</h2>
-<p>Use the <code>notification</code> function instead of <code>request</code>:
+<p>Use the <code>notification</code> function instead of <code>request</code>:</p>
 <div class="highlight"><pre><span></span><code><span class="o">&gt;&gt;&gt;</span> <span class="kn">from</span><span class="w"> </span><span class="nn">jsonrpcclient</span><span class="w"> </span><span class="kn">import</span> <span class="n">notification</span>
 <span class="o">&gt;&gt;&gt;</span> <span class="n">notification</span><span class="p">(</span><span class="s2">&quot;ping&quot;</span><span class="p">)</span>
 <span class="p">{</span><span class="s2">&quot;jsonrpc&quot;</span><span class="p">:</span> <span class="s2">&quot;2.0&quot;</span><span class="p">,</span> <span class="s2">&quot;method&quot;</span><span class="p">:</span> <span class="s2">&quot;ping&quot;</span><span class="p">}</span>
-</code></pre></div></p>
-<p>Similar to <code>request_json</code>, <code>notification_json</code> will give you the notification
-as a JSON string.</p>
+</code></pre></div>
+<p>As with <code>request_json</code>, <code>notification_json</code> will give you the notification as a
+JSON string.</p>
 <div class="highlight"><pre><span></span><code><span class="o">&gt;&gt;&gt;</span> <span class="kn">from</span><span class="w"> </span><span class="nn">jsonrpcclient</span><span class="w"> </span><span class="kn">import</span> <span class="n">notification_json</span>
 <span class="o">&gt;&gt;&gt;</span> <span class="n">notification_json</span><span class="p">(</span><span class="s2">&quot;ping&quot;</span><span class="p">)</span>
 <span class="s1">&#39;{&quot;jsonrpc&quot;: &quot;2.0&quot;, &quot;method&quot;: &quot;ping&quot;}&#39;</span>