Skip to content

Commit b875615

Browse files
committed
update a couple missed docstrings
1 parent ffda616 commit b875615

5 files changed

Lines changed: 9 additions & 5 deletions

File tree

‎_modules/cassandra/cluster.html‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -278,6 +278,8 @@ <h1>Source code for cassandra.cluster</h1><div class="highlight"><pre>
278278
<span class="sd"> &gt;&gt;&gt; ...</span>
279279
<span class="sd"> &gt;&gt;&gt; cluster.shutdown()</span>
280280

281+
<span class="sd"> ``Cluster`` and ``Session`` also provide context management functions</span>
282+
<span class="sd"> which implicitly handle shutdown when leaving scope.</span>
281283
<span class="sd"> &quot;&quot;&quot;</span>
282284

283285
<span class="n">contact_points</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;127.0.0.1&#39;</span><span class="p">]</span>

‎_modules/cassandra/concurrent.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -124,8 +124,8 @@ <h1>Source code for cassandra.concurrent</h1><div class="highlight"><pre>
124124
<span class="sd"> footprint is marginal CPU overhead (more thread coordination and sorting out-of-order results</span>
125125
<span class="sd"> on-the-fly).</span>
126126

127-
<span class="sd"> A sequence of ``(success, result_or_exc)`` tuples is returned in the same</span>
128-
<span class="sd"> order that the statements were passed in. If ``success`` is :const:`False`,</span>
127+
<span class="sd"> A sequence of ``ExecutionResult(success, result_or_exc)`` namedtuples is returned</span>
128+
<span class="sd"> in the same order that the statements were passed in. If ``success`` is :const:`False`,</span>
129129
<span class="sd"> there was an error executing the statement, and ``result_or_exc`` will be</span>
130130
<span class="sd"> an :class:`Exception`. If ``success`` is :const:`True`, ``result_or_exc``</span>
131131
<span class="sd"> will be the query result.</span>

‎api/cassandra/cluster.html‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,8 @@ <h3>Quick search</h3>
101101
<span class="gp">&gt;&gt;&gt; </span><span class="n">cluster</span><span class="o">.</span><span class="n">shutdown</span><span class="p">()</span>
102102
</pre></div>
103103
</div>
104+
<p><code class="docutils literal"><span class="pre">Cluster</span></code> and <code class="docutils literal"><span class="pre">Session</span></code> also provide context management functions
105+
which implicitly handle shutdown when leaving scope.</p>
104106
<p>Any of the mutable Cluster attributes may be set as keyword arguments
105107
to the constructor.</p>
106108
<p>Any of the mutable Cluster attributes may be set as keyword arguments to the constructor.</p>

‎api/cassandra/concurrent.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -111,8 +111,8 @@ <h3>Quick search</h3>
111111
footprint is marginal CPU overhead (more thread coordination and sorting out-of-order results
112112
on-the-fly).</p>
113113
</div></blockquote>
114-
<p>A sequence of <code class="docutils literal"><span class="pre">(success,</span> <span class="pre">result_or_exc)</span></code> tuples is returned in the same
115-
order that the statements were passed in. If <code class="docutils literal"><span class="pre">success</span></code> is <code class="xref py py-const docutils literal"><span class="pre">False</span></code>,
114+
<p>A sequence of <code class="docutils literal"><span class="pre">ExecutionResult(success,</span> <span class="pre">result_or_exc)</span></code> namedtuples is returned
115+
in the same order that the statements were passed in. If <code class="docutils literal"><span class="pre">success</span></code> is <code class="xref py py-const docutils literal"><span class="pre">False</span></code>,
116116
there was an error executing the statement, and <code class="docutils literal"><span class="pre">result_or_exc</span></code> will be
117117
an <code class="xref py py-class docutils literal"><span class="pre">Exception</span></code>. If <code class="docutils literal"><span class="pre">success</span></code> is <code class="xref py py-const docutils literal"><span class="pre">True</span></code>, <code class="docutils literal"><span class="pre">result_or_exc</span></code>
118118
will be the query result.</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)