commit 20d29a10a483fd36b0ba83476d06ea822342168d
author David Tolnay <dtolnay@gmail.com> Sat Sep 01 15:15:33 2018 -0700
committer David Tolnay <dtolnay@gmail.com> Sat Sep 01 15:15:33 2018 -0700
tree 5334f6c5cec8148a8b36ff0df9073deb3acc527d
parent 0abe65b4103c1622c1c918ec240045f9ee001d6a

Explain ParseBuffer

src/parse.rs

diff --git a/src/parse.rs b/src/parse.rs
index 8914696..8d51fd8 100644
--- a/src/parse.rs
+++ b/src/parse.rs
@@ -155,6 +155,12 @@
 pub type ParseStream<'a> = &'a ParseBuffer<'a>;
 
 /// Cursor position within a buffered token stream.
+///
+/// This type is more commonly used through the type alias [`ParseStream`] which
+/// is an alias for `&ParseBuffer`.
+///
+/// `ParseStream` is the input type for all parser functions in Syn. They have
+/// the signature `fn(ParseStream) -> Result<T>`.
 pub struct ParseBuffer<'a> {
     scope: Span,
     cell: Cell<Cursor<'static>>,