Generated documentation for triqs/unstable

jenkins-TRIQS-triqs-unstable-1059 8bc7491ff20fe2b1188f9c582048bdc7b3e42d7c
TRIQS · Dec 11, 2024 · 34485e0 · 34485e0
1 parent 5174633
commit 34485e0
Show file tree

Hide file tree

Showing 28 changed files with 60 additions and 60 deletions.
diff --git a/triqs/unstable/_modules/triqs/gf/block_gf.html b/triqs/unstable/_modules/triqs/gf/block_gf.html
diff --git a/triqs/unstable/_modules/triqs/gf/descriptor_base.html b/triqs/unstable/_modules/triqs/gf/descriptor_base.html
@@ -1800,10 +1800,10 @@ <h1>Source code for triqs.gf.descriptor_base</h1><div class="highlight"><pre>
 <span class="kn">from</span> <span class="nn">.meshes</span> <span class="kn">import</span> <span class="n">MeshImFreq</span><span class="p">,</span> <span class="n">MeshDLRImFreq</span><span class="p">,</span> <span class="n">MeshReFreq</span>
 
 <div class="viewcode-block" id="LazyCTX">
-<a class="viewcode-back" href="../../../documentation/python_api/triqs.gf.descriptor_base.LazyCTX.html#triqs.gf.descriptors.LazyCTX">[docs]</a>
+<a class="viewcode-back" href="../../../documentation/python_api/triqs.gf.descriptor_base.LazyCTX.html#triqs.gf.descriptor_base.LazyCTX">[docs]</a>
 <span class="k">class</span> <span class="nc">LazyCTX</span><span class="p">:</span>
 <div class="viewcode-block" id="LazyCTX.__init__">
-<a class="viewcode-back" href="../../../documentation/python_api/triqs.gf.descriptor_base.LazyCTX.__init__.html#triqs.gf.descriptors.LazyCTX.__init__">[docs]</a>
+<a class="viewcode-back" href="../../../documentation/python_api/triqs.gf.descriptor_base.LazyCTX.__init__.html#triqs.gf.descriptor_base.LazyCTX.__init__">[docs]</a>
     <span class="k">def</span> <span class="fm">__init__</span> <span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">G</span><span class="p">):</span> 
         <span class="bp">self</span><span class="o">.</span><span class="n">G</span> <span class="o">=</span> <span class="n">G</span></div>
 
@@ -1821,19 +1821,19 @@ <h1>Source code for triqs.gf.descriptor_base</h1><div class="highlight"><pre>
 
 
 <div class="viewcode-block" id="is_lazy">
-<a class="viewcode-back" href="../../../documentation/python_api/triqs.gf.descriptor_base.is_lazy.html#triqs.gf.descriptors.is_lazy">[docs]</a>
+<a class="viewcode-back" href="../../../documentation/python_api/triqs.gf.descriptor_base.is_lazy.html#triqs.gf.descriptor_base.is_lazy">[docs]</a>
 <span class="k">def</span> <span class="nf">is_lazy</span><span class="p">(</span><span class="n">y</span><span class="p">):</span>
     <span class="k">return</span>  <span class="nb">isinstance</span><span class="p">(</span><span class="n">y</span><span class="p">,(</span><span class="n">Omega_</span><span class="p">,</span> <span class="n">LazyExpr</span><span class="p">,</span> <span class="n">LazyExprTerminal</span><span class="p">))</span></div>
 
 
 <div class="viewcode-block" id="is_scalar">
-<a class="viewcode-back" href="../../../documentation/python_api/triqs.gf.descriptor_base.is_scalar.html#triqs.gf.descriptors.is_scalar">[docs]</a>
+<a class="viewcode-back" href="../../../documentation/python_api/triqs.gf.descriptor_base.is_scalar.html#triqs.gf.descriptor_base.is_scalar">[docs]</a>
 <span class="k">def</span> <span class="nf">is_scalar</span><span class="p">(</span><span class="n">x</span><span class="p">):</span> 
     <span class="k">return</span> <span class="nb">type</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="ow">in</span> <span class="p">[</span> <span class="nb">type</span><span class="p">(</span><span class="mi">1</span><span class="p">),</span> <span class="nb">type</span><span class="p">(</span><span class="mf">1.0</span><span class="p">),</span> <span class="nb">type</span><span class="p">(</span><span class="mi">1</span><span class="n">j</span><span class="p">),</span> <span class="n">numpy</span><span class="o">.</span><span class="n">ndarray</span><span class="p">,</span> <span class="nb">int</span><span class="p">,</span> <span class="n">numpy</span><span class="o">.</span><span class="n">int_</span><span class="p">,</span> <span class="n">numpy</span><span class="o">.</span><span class="n">int8</span><span class="p">,</span> <span class="n">numpy</span><span class="o">.</span><span class="n">int16</span><span class="p">,</span> <span class="n">numpy</span><span class="o">.</span><span class="n">int32</span><span class="p">,</span> <span class="nb">float</span><span class="p">,</span> <span class="n">numpy</span><span class="o">.</span><span class="n">float32</span><span class="p">,</span> <span class="n">numpy</span><span class="o">.</span><span class="n">float64</span><span class="p">,</span> <span class="nb">complex</span><span class="p">,</span> <span class="n">numpy</span><span class="o">.</span><span class="n">complex64</span><span class="p">,</span> <span class="n">numpy</span><span class="o">.</span><span class="n">complex128</span> <span class="p">]</span></div>
 
 
 <div class="viewcode-block" id="convert_scalar_to_const">
-<a class="viewcode-back" href="../../../documentation/python_api/triqs.gf.descriptor_base.convert_scalar_to_const.html#triqs.gf.descriptors.convert_scalar_to_const">[docs]</a>
+<a class="viewcode-back" href="../../../documentation/python_api/triqs.gf.descriptor_base.convert_scalar_to_const.html#triqs.gf.descriptor_base.convert_scalar_to_const">[docs]</a>
 <span class="k">def</span> <span class="nf">convert_scalar_to_const</span><span class="p">(</span><span class="n">expr</span><span class="p">):</span> 
 
   <span class="c1"># if the expression is a pure scalar, replace it by Const</span>
@@ -1852,29 +1852,29 @@ <h1>Source code for triqs.gf.descriptor_base</h1><div class="highlight"><pre>
 
 
 <div class="viewcode-block" id="Base">
-<a class="viewcode-back" href="../../../documentation/python_api/triqs.gf.descriptor_base.Base.html#triqs.gf.descriptors.Base">[docs]</a>
+<a class="viewcode-back" href="../../../documentation/python_api/triqs.gf.descriptor_base.Base.html#triqs.gf.descriptor_base.Base">[docs]</a>
 <span class="k">class</span> <span class="nc">Base</span> <span class="p">(</span><span class="n">LazyExprTerminal</span><span class="p">):</span>
 <div class="viewcode-block" id="Base.__init__">
-<a class="viewcode-back" href="../../../documentation/python_api/triqs.gf.descriptor_base.Base.__init__.html#triqs.gf.descriptors.Base.__init__">[docs]</a>
+<a class="viewcode-back" href="../../../documentation/python_api/triqs.gf.descriptor_base.Base.__init__.html#triqs.gf.descriptor_base.Base.__init__">[docs]</a>
     <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span><span class="o">**</span><span class="n">kargs</span><span class="p">):</span>
         <span class="bp">self</span><span class="o">.</span><span class="vm">__dict__</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">kargs</span><span class="p">)</span></div>
 </div>
 
 
 <span class="c1"># The Base for any descriptor taking a BlockGf</span>
 <div class="viewcode-block" id="BaseBlock">
-<a class="viewcode-back" href="../../../documentation/python_api/triqs.gf.descriptor_base.BaseBlock.html#triqs.gf.descriptors.BaseBlock">[docs]</a>
+<a class="viewcode-back" href="../../../documentation/python_api/triqs.gf.descriptor_base.BaseBlock.html#triqs.gf.descriptor_base.BaseBlock">[docs]</a>
 <span class="k">class</span> <span class="nc">BaseBlock</span><span class="p">(</span><span class="n">Base</span><span class="p">):</span>
 <div class="viewcode-block" id="BaseBlock.__init__">
-<a class="viewcode-back" href="../../../documentation/python_api/triqs.gf.descriptor_base.BaseBlock.__init__.html#triqs.gf.descriptors.BaseBlock.__init__">[docs]</a>
+<a class="viewcode-back" href="../../../documentation/python_api/triqs.gf.descriptor_base.BaseBlock.__init__.html#triqs.gf.descriptor_base.BaseBlock.__init__">[docs]</a>
     <span class="k">def</span> <span class="fm">__init__</span> <span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">G</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kw</span><span class="p">):</span>
         <span class="n">Base</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">G</span> <span class="o">=</span> <span class="n">G</span><span class="p">)</span>
         <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_block_descriptor</span><span class="p">():</span>
             <span class="bp">self</span><span class="o">.</span><span class="n">descriptor_iter</span> <span class="o">=</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="vm">__class__</span><span class="p">(</span><span class="n">g</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kw</span><span class="p">)</span> <span class="k">for</span> <span class="n">i</span><span class="p">,</span><span class="n">g</span> <span class="ow">in</span> <span class="n">G</span><span class="p">)</span></div>
 
 
 <div class="viewcode-block" id="BaseBlock.is_block_descriptor">
-<a class="viewcode-back" href="../../../documentation/python_api/triqs.gf.descriptor_base.BaseBlock.is_block_descriptor.html#triqs.gf.descriptors.BaseBlock.is_block_descriptor">[docs]</a>
+<a class="viewcode-back" href="../../../documentation/python_api/triqs.gf.descriptor_base.BaseBlock.is_block_descriptor.html#triqs.gf.descriptor_base.BaseBlock.is_block_descriptor">[docs]</a>
     <span class="k">def</span> <span class="nf">is_block_descriptor</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">G</span><span class="o">.</span><span class="vm">__class__</span><span class="o">.</span><span class="vm">__name__</span> <span class="o">==</span> <span class="s1">&#39;BlockGf&#39;</span></div>
 
@@ -1886,15 +1886,15 @@ <h1>Source code for triqs.gf.descriptor_base</h1><div class="highlight"><pre>
 <span class="c1">#########################################################################</span>
 
 <div class="viewcode-block" id="Function">
-<a class="viewcode-back" href="../../../documentation/manual/triqs/gfs/py/descriptors.html#triqs.gf.descriptors.Function">[docs]</a>
+<a class="viewcode-back" href="../../../documentation/python_api/triqs.gf.descriptor_base.Function.html#triqs.gf.descriptor_base.Function">[docs]</a>
 <span class="k">class</span> <span class="nc">Function</span> <span class="p">(</span><span class="n">Base</span><span class="p">):</span>
 <span class="w">    </span><span class="sa">r</span><span class="sd">&quot;&quot;&quot;   </span>
 <span class="sd">       Stores a python function </span>
 <span class="sd">       </span>
 <span class="sd">       If the Green&#39;s function is defined on an array of points :math:`x_i`, then it will be initialized to :math:`F(x_i)`.</span>
 <span class="sd">    &quot;&quot;&quot;</span>
 <div class="viewcode-block" id="Function.__init__">
-<a class="viewcode-back" href="../../../documentation/python_api/triqs.gf.descriptor_base.Function.__init__.html#triqs.gf.descriptors.Function.__init__">[docs]</a>
+<a class="viewcode-back" href="../../../documentation/python_api/triqs.gf.descriptor_base.Function.__init__.html#triqs.gf.descriptor_base.Function.__init__">[docs]</a>
     <span class="k">def</span> <span class="fm">__init__</span> <span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">function</span><span class="p">):</span> 
 <span class="w">        </span><span class="sa">r</span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        :param function: the function :math:`\omega \rightarrow function(\omega)`</span>
@@ -1916,10 +1916,10 @@ <h1>Source code for triqs.gf.descriptor_base</h1><div class="highlight"><pre>
 <span class="c1">#########################################################################</span>
 
 <div class="viewcode-block" id="Const">
-<a class="viewcode-back" href="../../../documentation/python_api/triqs.gf.descriptor_base.Const.html#triqs.gf.descriptors.Const">[docs]</a>
+<a class="viewcode-back" href="../../../documentation/python_api/triqs.gf.descriptor_base.Const.html#triqs.gf.descriptor_base.Const">[docs]</a>
 <span class="k">class</span> <span class="nc">Const</span><span class="p">(</span><span class="n">Base</span><span class="p">):</span>
 <div class="viewcode-block" id="Const.__init__">
-<a class="viewcode-back" href="../../../documentation/python_api/triqs.gf.descriptor_base.Const.__init__.html#triqs.gf.descriptors.Const.__init__">[docs]</a>
+<a class="viewcode-back" href="../../../documentation/python_api/triqs.gf.descriptor_base.Const.__init__.html#triqs.gf.descriptor_base.Const.__init__">[docs]</a>
     <span class="k">def</span> <span class="fm">__init__</span> <span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">C</span><span class="p">):</span>
         <span class="n">Base</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">C</span><span class="o">=</span><span class="n">C</span><span class="p">)</span></div>
 
@@ -1941,7 +1941,7 @@ <h1>Source code for triqs.gf.descriptor_base</h1><div class="highlight"><pre>
 <span class="c1">#########################################################################</span>
 
 <div class="viewcode-block" id="Omega_">
-<a class="viewcode-back" href="../../../documentation/python_api/triqs.gf.descriptor_base.Omega_.html#triqs.gf.descriptors.Omega_">[docs]</a>
+<a class="viewcode-back" href="../../../documentation/python_api/triqs.gf.descriptor_base.Omega_.html#triqs.gf.descriptor_base.Omega_">[docs]</a>
 <span class="k">class</span> <span class="nc">Omega_</span><span class="p">(</span><span class="n">Base</span><span class="p">):</span>
 <span class="w">    </span><span class="sa">r</span><span class="sd">&quot;&quot;&quot;The function:math:`\omega \rightarrow \omega` &quot;&quot;&quot;</span>
     <span class="k">def</span> <span class="fm">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> <span class="k">return</span> <span class="s2">&quot;Omega&quot;</span> 

diff --git a/triqs/unstable/_modules/triqs/gf/descriptors.html b/triqs/unstable/_modules/triqs/gf/descriptors.html
@@ -1845,7 +1845,7 @@ <h1>Source code for triqs.gf.descriptors</h1><div class="highlight"><pre>
 <span class="c1">##################################################</span>
 
 <div class="viewcode-block" id="SemiCircular">
-<a class="viewcode-back" href="../../../documentation/manual/triqs/gfs/py/descriptors.html#triqs.gf.descriptors.SemiCircular">[docs]</a>
+<a class="viewcode-back" href="../../../documentation/python_api/triqs.gf.descriptors.SemiCircular.html#triqs.gf.descriptors.SemiCircular">[docs]</a>
 <span class="k">class</span> <span class="nc">SemiCircular</span> <span class="p">(</span><span class="n">Base</span><span class="p">):</span>
 <span class="w">    </span><span class="sa">r</span><span class="sd">&quot;&quot;&quot;Hilbert transform of a semicircular density of states, i.e.</span>
 
@@ -1898,7 +1898,7 @@ <h1>Source code for triqs.gf.descriptors</h1><div class="highlight"><pre>
 <span class="c1">##################################################</span>
 
 <div class="viewcode-block" id="Flat">
-<a class="viewcode-back" href="../../../documentation/manual/triqs/gfs/py/descriptors.html#triqs.gf.descriptors.Flat">[docs]</a>
+<a class="viewcode-back" href="../../../documentation/python_api/triqs.gf.descriptors.Flat.html#triqs.gf.descriptors.Flat">[docs]</a>
 <span class="k">class</span> <span class="nc">Flat</span> <span class="p">(</span><span class="n">Base</span><span class="p">):</span>
 <span class="w">    </span><span class="sa">r</span><span class="sd">&quot;&quot;&quot;The Hilbert transform of a flat density of states, with cut-off</span>
 

diff --git a/.../unstable/_sources/documentation/cpp_api/itertools/enum_iter/operator==.rst.txt b/.../unstable/_sources/documentation/cpp_api/itertools/enum_iter/operator==.rst.txt
@@ -48,4 +48,4 @@ Parameters
 Returns
 ^^^^^^^
 
-True, if the original iterators are equal.
+True, if the original iterator is equal to the iterator stored in the sentinel.
diff --git a/...TIter,Value,std::forward_iterator_tag,Reference,DifferenceGT/operator++.rst.txt b/...TIter,Value,std::forward_iterator_tag,Reference,DifferenceGT/operator++.rst.txt
@@ -33,4 +33,4 @@ Documentation
 Returns
 ^^^^^^^
 
-Copy of the derived iterator before calling the derived iterator's `increment()` function.
+Reference to the derived iterator after calling the derived iterator's `increment()` function.
diff --git a/...able/_sources/documentation/cpp_api/itertools/transform_iter/operator==.rst.txt b/...able/_sources/documentation/cpp_api/itertools/transform_iter/operator==.rst.txt
@@ -48,4 +48,4 @@ Parameters
 Returns
 ^^^^^^^
 
-True, if the original iterators are equal.
+True, if the original iterator is equal to the iterator stored in the sentinel.
diff --git a/...s/unstable/_sources/documentation/cpp_api/itertools/zip_iter/operator==.rst.txt b/...s/unstable/_sources/documentation/cpp_api/itertools/zip_iter/operator==.rst.txt
@@ -48,4 +48,4 @@ Parameters
 Returns
 ^^^^^^^
 
-True, if all original iterators are equal.
+True, if one of the original iterators is equal to the corresponding iterator of the sentinel.
diff --git a/triqs/unstable/_sources/documentation/cpp_api/mpi/mpi_gather.rst.txt b/triqs/unstable/_sources/documentation/cpp_api/mpi/mpi_gather.rst.txt
@@ -54,4 +54,4 @@ Parameters
 Returns
 ^^^^^^^
 
-std::vector containing the result of the gather operation.
+std::string containing the result of the gather operation.
diff --git a/triqs/unstable/_sources/documentation/cpp_api/mpi/mpi_reduce.rst.txt b/triqs/unstable/_sources/documentation/cpp_api/mpi/mpi_reduce.rst.txt
@@ -85,4 +85,4 @@ Parameters
 Returns
 ^^^^^^^
 
-std::array containing the result of each individual reduction.
+std::vector containing the result of each individual reduction.
diff --git a/...i/triqs/hilbert_space/stateLTHilbertSpace,ScalarType,falseGT/operator().rst.txt b/...i/triqs/hilbert_space/stateLTHilbertSpace,ScalarType,falseGT/operator().rst.txt
@@ -47,4 +47,4 @@ Parameters
 Returns
 ^^^^^^^
 
-Reference to the requested amplitude
+Constant reference to the requested amplitude
diff --git a/...pi/triqs/hilbert_space/stateLTHilbertSpace,ScalarType,trueGT/operator().rst.txt b/...pi/triqs/hilbert_space/stateLTHilbertSpace,ScalarType,trueGT/operator().rst.txt
@@ -47,4 +47,4 @@ Parameters
 Returns
 ^^^^^^^
 
-Reference to the requested amplitude
+Constant reference to the requested amplitude
diff --git a/triqs/unstable/documentation/cpp_api/itertools/enum_iter/operator==.html b/triqs/unstable/documentation/cpp_api/itertools/enum_iter/operator==.html
@@ -1838,7 +1838,7 @@ <h2>Parameters<a class="headerlink" href="#parameters" title="Link to this headi
 </section>
 <section id="returns">
 <h2>Returns<a class="headerlink" href="#returns" title="Link to this heading"></a></h2>
-<p>True, if the original iterators are equal.</p>
+<p>True, if the original iterator is equal to the iterator stored in the sentinel.</p>
 </section>
 </section>
 

diff --git a/...rator_facadeLTIter,Value,std::forward_iterator_tag,Reference,DifferenceGT/operator++.html b/...rator_facadeLTIter,Value,std::forward_iterator_tag,Reference,DifferenceGT/operator++.html
@@ -1820,7 +1820,7 @@
 <p>Documentation</p>
 <section id="returns">
 <h2>Returns<a class="headerlink" href="#returns" title="Link to this heading"></a></h2>
-<p>Copy of the derived iterator before calling the derived iterator’s <cite>increment()</cite> function.</p>
+<p>Reference to the derived iterator after calling the derived iterator’s <cite>increment()</cite> function.</p>
 </section>
 </section>
 

diff --git a/triqs/unstable/documentation/cpp_api/itertools/transform_iter/operator==.html b/triqs/unstable/documentation/cpp_api/itertools/transform_iter/operator==.html
@@ -1838,7 +1838,7 @@ <h2>Parameters<a class="headerlink" href="#parameters" title="Link to this headi
 </section>
 <section id="returns">
 <h2>Returns<a class="headerlink" href="#returns" title="Link to this heading"></a></h2>
-<p>True, if the original iterators are equal.</p>
+<p>True, if the original iterator is equal to the iterator stored in the sentinel.</p>
 </section>
 </section>
 

diff --git a/triqs/unstable/documentation/cpp_api/itertools/zip_iter/operator==.html b/triqs/unstable/documentation/cpp_api/itertools/zip_iter/operator==.html
@@ -1838,7 +1838,7 @@ <h2>Parameters<a class="headerlink" href="#parameters" title="Link to this headi
 </section>
 <section id="returns">
 <h2>Returns<a class="headerlink" href="#returns" title="Link to this heading"></a></h2>
-<p>True, if all original iterators are equal.</p>
+<p>True, if one of the original iterators is equal to the corresponding iterator of the sentinel.</p>
 </section>
 </section>
 

diff --git a/triqs/unstable/documentation/cpp_api/mpi/mpi_gather.html b/triqs/unstable/documentation/cpp_api/mpi/mpi_gather.html
@@ -1840,7 +1840,7 @@ <h2>Parameters<a class="headerlink" href="#parameters" title="Link to this headi
 </section>
 <section id="returns">
 <h2>Returns<a class="headerlink" href="#returns" title="Link to this heading"></a></h2>
-<p>std::vector containing the result of the gather operation.</p>
+<p>std::string containing the result of the gather operation.</p>
 </section>
 </section>
 

diff --git a/triqs/unstable/documentation/cpp_api/mpi/mpi_reduce.html b/triqs/unstable/documentation/cpp_api/mpi/mpi_reduce.html
@@ -1875,7 +1875,7 @@ <h2>Parameters<a class="headerlink" href="#parameters" title="Link to this headi
 </section>
 <section id="returns">
 <h2>Returns<a class="headerlink" href="#returns" title="Link to this heading"></a></h2>
-<p>std::array containing the result of each individual reduction.</p>
+<p>std::vector containing the result of each individual reduction.</p>
 </section>
 </section>
 

diff --git a/...tation/cpp_api/triqs/hilbert_space/stateLTHilbertSpace,ScalarType,falseGT/operator().html b/...tation/cpp_api/triqs/hilbert_space/stateLTHilbertSpace,ScalarType,falseGT/operator().html
@@ -1832,7 +1832,7 @@ <h2>Parameters<a class="headerlink" href="#parameters" title="Link to this headi
 </section>
 <section id="returns">
 <h2>Returns<a class="headerlink" href="#returns" title="Link to this heading"></a></h2>
-<p>Reference to the requested amplitude</p>
+<p>Constant reference to the requested amplitude</p>
 </section>
 </section>
-Original file line number
+Diff line change
@@ Expand Up / @@ -48,4 +48,4 @@ Parameters @@
     Returns
     ^^^^^^^
-    True, if the original iterators are equal.
+    True, if the original iterator is equal to the iterator stored in the sentinel.