Merge pull request #757 from gwenn/iterators_doc

Try to explain why we need a map function

src/row.rs

@@ -95,6 +95,7 @@ impl Drop for Rows<'_> {
     }
 }
 
+/// `F` is used to tranform the _streaming_ iterator into a _fallible_ iterator.
 pub struct Map<'stmt, F> {
     rows: Rows<'stmt>,
     f: F,
@@ -116,6 +117,8 @@ where
 }
 
 /// An iterator over the mapped resulting rows of a query.
+///
+/// `F` is used to tranform the _streaming_ iterator into a _standard_ iterator.
 pub struct MappedRows<'stmt, F> {
     rows: Rows<'stmt>,
     map: F,

src/statement.rs

@@ -219,6 +219,8 @@ impl Statement<'_> {
     ///     Ok(names)
     /// }
     /// ```
+    /// `f` is used to tranform the _streaming_ iterator into a _standard_
+    /// iterator.
     ///
     /// ## Failure
     ///
@@ -256,6 +258,8 @@ impl Statement<'_> {
     ///     Ok(names)
     /// }
     /// ```
+    /// `f` is used to tranform the _streaming_ iterator into a _standard_
+    /// iterator.
     ///
     /// ## Failure
     ///