Merge pull request #34 from J5lx/metis-reader-seeking

Document that metis_reader expects a seekable stream

Author: jeremy-murphy

doc/html/metis.html

@@ -124,8 +124,9 @@ <h1><a class="toc-backref" href="#id7">Member Functions</a></h1>
 metis_reader(std::istream&amp; in);
 </pre>
 <p>Constructs a new METIS reader that will retrieve edges from the input
-stream <tt class="docutils literal"><span class="pre">in</span></tt>. If any errors are encountered while initially parsing
-<tt class="docutils literal"><span class="pre">in</span></tt>, <tt class="docutils literal"><span class="pre">metis_input_exception</span></tt> will be thrown.</p>
+stream <tt class="docutils literal"><span class="pre">in</span></tt>. The reader will read from the very beginning of the stream,
+and to this end, <tt class="docutils literal"><span class="pre">in</span></tt> must support seeking. If any errors are encountered
+while initially parsing <tt class="docutils literal"><span class="pre">in</span></tt>, <tt class="docutils literal"><span class="pre">metis_input_exception</span></tt> will be thrown.</p>
 <hr class="docutils" />
 <pre class="literal-block">
 edge_iterator begin();
@@ -266,7 +267,7 @@ <h1><a class="toc-backref" href="#id10">Member Functions</a></h1>
 </div>
 <div class="footer">
 <hr class="footer" />
-Generated on: 2009-05-31 00:21 UTC.
+Generated on: 2022-02-19 18:10 UTC.
 Generated by <a class="reference external" href="http://docutils.sourceforge.net/">Docutils</a> from <a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source.
 
 </div>

doc/metis.rst

@@ -118,8 +118,9 @@ Member Functions
   metis_reader(std::istream& in);
 
 Constructs a new METIS reader that will retrieve edges from the input
-stream ``in``. If any errors are encountered while initially parsing
-``in``, ``metis_input_exception`` will be thrown.
+stream ``in``. The reader will read from the very beginning of the stream,
+and to this end, ``in`` must support seeking. If any errors are encountered
+while initially parsing ``in``, ``metis_input_exception`` will be thrown.
 
 -----------------------------------------------------------------------------