diff --git a/doc/html/metis.html b/doc/html/metis.html index 8ca97457..9f816f03 100644 --- a/doc/html/metis.html +++ b/doc/html/metis.html @@ -124,8 +124,9 @@
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.edge_iterator begin(); @@ -266,7 +267,7 @@Member Functions
diff --git a/doc/metis.rst b/doc/metis.rst index 17eb51ae..4a917fa3 100644 --- a/doc/metis.rst +++ b/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. -----------------------------------------------------------------------------