Skip to content

Commit acabf3b

Browse files
committed
[skip ci] Documentation updates
1 parent c9fda19 commit acabf3b

File tree

5 files changed

+11
-5
lines changed

5 files changed

+11
-5
lines changed

.doctrees/client.doctree

3.13 KB
Binary file not shown.

.doctrees/environment.pickle

197 Bytes
Binary file not shown.

_modules/pyroclient/client.html

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -443,7 +443,7 @@ <h1>Source code for pyroclient.client</h1><div class="highlight"><pre>
443443
<span class="n">timeout</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">timeout</span><span class="p">,</span>
444444
<span class="p">)</span></div>
445445

446-
<div class="viewcode-block" id="Client.fetch_sequences_from_date"><a class="viewcode-back" href="../../client.html#pyroclient.client.Client.fetch_sequences_from_date">[docs]</a> <span class="k">def</span><span class="w"> </span><span class="nf">fetch_sequences_from_date</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">from_date</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Response</span><span class="p">:</span>
446+
<div class="viewcode-block" id="Client.fetch_sequences_from_date"><a class="viewcode-back" href="../../client.html#pyroclient.client.Client.fetch_sequences_from_date">[docs]</a> <span class="k">def</span><span class="w"> </span><span class="nf">fetch_sequences_from_date</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">from_date</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">limit</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">15</span><span class="p">,</span> <span class="n">offset</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">0</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Response</span><span class="p">:</span>
447447
<span class="w"> </span><span class="sd">&quot;&quot;&quot;List the sequences accessible to the authenticated user for a specific date</span>
448448

449449
<span class="sd"> &gt;&gt;&gt; from pyroclient import client</span>
@@ -452,11 +452,13 @@ <h1>Source code for pyroclient.client</h1><div class="highlight"><pre>
452452

453453
<span class="sd"> Args:</span>
454454
<span class="sd"> from_date: date of the sequences to fetch</span>
455+
<span class="sd"> limit: maximum number of sequences to fetch</span>
456+
<span class="sd"> offset: number of sequences to skip before starting to fetch</span>
455457

456458
<span class="sd"> Returns:</span>
457459
<span class="sd"> HTTP response</span>
458460
<span class="sd"> &quot;&quot;&quot;</span>
459-
<span class="n">params</span> <span class="o">=</span> <span class="p">{</span><span class="s2">&quot;from_date&quot;</span><span class="p">:</span> <span class="n">from_date</span><span class="p">}</span>
461+
<span class="n">params</span> <span class="o">=</span> <span class="p">{</span><span class="s2">&quot;from_date&quot;</span><span class="p">:</span> <span class="n">from_date</span><span class="p">,</span> <span class="s2">&quot;limit&quot;</span><span class="p">:</span> <span class="n">limit</span><span class="p">,</span> <span class="s2">&quot;offset&quot;</span><span class="p">:</span> <span class="n">offset</span><span class="p">}</span>
460462
<span class="k">return</span> <span class="n">requests</span><span class="o">.</span><span class="n">get</span><span class="p">(</span>
461463
<span class="n">urljoin</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_route_prefix</span><span class="p">,</span> <span class="n">ClientRoute</span><span class="o">.</span><span class="n">SEQUENCES_FETCH_FROMDATE</span><span class="p">),</span>
462464
<span class="n">headers</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">headers</span><span class="p">,</span>

client.html

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -336,7 +336,7 @@ <h2>API Client<a class="headerlink" href="#api-client" title="Permalink to this
336336

337337
<dl class="py method">
338338
<dt class="sig sig-object py" id="pyroclient.client.Client.fetch_sequences_from_date">
339-
<span class="sig-name descname"><span class="pre">fetch_sequences_from_date</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">from_date</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Response</span></span></span><a class="reference internal" href="_modules/pyroclient/client.html#Client.fetch_sequences_from_date"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyroclient.client.Client.fetch_sequences_from_date" title="Permalink to this definition">#</a></dt>
339+
<span class="sig-name descname"><span class="pre">fetch_sequences_from_date</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">from_date</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">15</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">offset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Response</span></span></span><a class="reference internal" href="_modules/pyroclient/client.html#Client.fetch_sequences_from_date"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyroclient.client.Client.fetch_sequences_from_date" title="Permalink to this definition">#</a></dt>
340340
<dd><p>List the sequences accessible to the authenticated user for a specific date</p>
341341
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span><span class="w"> </span><span class="nn">pyroclient</span><span class="w"> </span><span class="kn">import</span> <span class="n">client</span>
342342
<span class="gp">&gt;&gt;&gt; </span><span class="n">api_client</span> <span class="o">=</span> <span class="n">Client</span><span class="p">(</span><span class="s2">&quot;MY_USER_TOKEN&quot;</span><span class="p">)</span>
@@ -345,7 +345,11 @@ <h2>API Client<a class="headerlink" href="#api-client" title="Permalink to this
345345
</div>
346346
<dl class="field-list simple">
347347
<dt class="field-odd">Parameters</dt>
348-
<dd class="field-odd"><p><strong>from_date</strong> – date of the sequences to fetch</p>
348+
<dd class="field-odd"><ul class="simple">
349+
<li><p><strong>from_date</strong> – date of the sequences to fetch</p></li>
350+
<li><p><strong>limit</strong> – maximum number of sequences to fetch</p></li>
351+
<li><p><strong>offset</strong> – number of sequences to skip before starting to fetch</p></li>
352+
</ul>
349353
</dd>
350354
<dt class="field-even">Returns</dt>
351355
<dd class="field-even"><p>HTTP response</p>

searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)