beautify doc

Author: viruscamp

src/gen_iter.rs

@@ -3,7 +3,7 @@ use core::iter::Iterator;
 use core::marker::Unpin;
 use core::pin::Pin;
 
-/// a iterator that holds an internal generator representing
+/// an iterator that holds an internal generator representing
 /// the iteration state
 #[derive(Copy, Clone, Debug)]
 pub struct GenIter<T>(pub T)

src/gen_iter_return.rs

@@ -3,7 +3,8 @@ use core::iter::{Iterator, FusedIterator};
 use core::marker::Unpin;
 use core::pin::Pin;
 
-/// `GenIterReturn<G>` is a iterator for generator with return value.
+/// `GenIterReturn<G>` holds a generator `G` or the return value of `G`,
+/// `&mut GenIterReturn<G>` acts as an iterator.
 /// 
 /// Differences with `GenIter<G>`:
 /// 1. able to get return value of a generator
@@ -35,11 +36,12 @@ impl<G: Generator + Unpin> GenIterReturn<G> {
 /// Force use `&mut g` as iterator to prevent the code below,
 /// in which return value cannot be got.
 /// ```compile_fail
+/// // !!INVALID CODE!!
 /// # #![feature(generators)]
 /// # use gen_iter::gen_iter_return;
-/// let mut g = gen_iter_return!({ yield 1; return "done"; }
+/// let mut g = gen_iter_return!({ yield 1; return "done"; });
 /// for v in g {} // invalid, because `GenIterReturn<G>` is not `Iterator`
-/// let ret = g.return_or_self().unwrap(); // g is dropped after for
+/// let ret = g.return_or_self(); // g is dropped after for loop
 /// ```
 impl<G: Generator + Unpin> Iterator for &mut GenIterReturn<G> {
     type Item = G::Yield;

src/lib.rs

@@ -1,11 +1,13 @@
 //! # gen_iter - create generators to use as iterators
 //!
-//! `GenIter` converts a generator into an iterator over the
+//! ## [`GenIter`] and [`gen_iter!`]
+//! [`GenIter`] converts a [`Generator<(), Return=()>`](core::ops::Generator) into an iterator over the
 //! yielded type of the generator. The return type of the generator needs to be `()`.
+//! 
+//! [`gen_iter!`] helps to create a [`GenIter`]
 //!
 //! ```
 //! #![feature(generators)]
-//! #![feature(conservative_impl_trait)]
 //!
 //! use gen_iter::gen_iter;
 //!
@@ -29,9 +31,12 @@
 //! }
 //! ```
 //! 
-//! `GenIterReturn` can be converted from a `Generator<()>`,
-//! `&mut GenIterReturn` can be used as iterator.
-//! The return value of the generator can be got after the iterator is done.
+//! ## [`GenIterReturn`] and [`gen_iter_return!`]
+//! [`GenIterReturn`] can be converted from a [`Generator<()>`](core::ops::Generator),
+//! `&mut GenIterReturn<G>` can be used as iterator.
+//! The return value of the generator can be got after the iterator is exhausted.
+//! 
+//! [`gen_iter_return!`] helps to create a [`GenIterReturn`].
 //! 
 //! ```
 //! #![feature(generators)]