[elpa] master 8f0c266 58/60: Add doc for parsec-peek(-p)

[Junpeng Qiu]

branch: master
commit 8f0c266d8b9b0ee5fcf9b80c518644b2849ff3b3
Author: Junpeng Qiu <address@hidden>
Commit: Junpeng Qiu <address@hidden>

    Add doc for parsec-peek(-p)
---
 README.org |    7 +++++++
 parsec.el  |    7 +++++++
 2 files changed, 14 insertions(+)

diff --git a/README.org b/README.org
index 6738fce..53d08db 100644
--- a/README.org
+++ b/README.org
@@ -34,6 +34,10 @@ So we can
   these functions and macros and try them to see the results! They are really
   easy to learn and use!
 
+  The *Usage* column for each function/combinator in the following tables is
+  much simplified. Check the docstring of the function/combinator to see the
+  full description.
+
 ** Basic Parsing Functions
    These parsing functions are used as the basic building block for a parser. 
By
    default, their return value is a *string*.
@@ -71,6 +75,9 @@ So we can
   
|---------------------------+------------------+--------------------------------------------------------------|
   | parsec-or                 | choice           | try the parsers until one 
succeeds                           |
   | parsec-try                | try              | try parser and consume no 
input when an error occurs         |
+  | parsec-lookahead          | lookahead        | try parser and consume no 
input when successful              |
+  | parsec-peek               | try && lookahead | try parser without 
comsuming any input                       |
+  | parsec-peek-p             | try && lookahead | same as parsec-peek except 
the return value for failure      |
   | parsec-with-error-message | <?> (similar)    | use the new error message 
when an error occurs               |
   | parsec-many               | many             | apply the parser zero or 
more times                          |
   | parsec-many1              | many1            | apply the parser one or 
more times                           |
diff --git a/parsec.el b/parsec.el
index 43e3727..468ecda 100644
--- a/parsec.el
+++ b/parsec.el
@@ -95,6 +95,10 @@
 ;;   at the docstrings of these functions and macros and try them to see
 ;;   the results! They are really easy to learn and use!
 
+;;   The *Usage* column for each function/combinator in the following
+;;   tables is much simplified. Check the docstring of the
+;;   function/combinator to see the full description.
+
 
 ;; 2.1 Basic Parsing Functions
 ;; ~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -140,6 +144,9 @@
 ;;   
-----------------------------------------------------------------------------------------------------------
 ;;    parsec-or                  choice            try the parsers until one 
succeeds
 ;;    parsec-try                 try               try parser and consume no 
input when an error occurs
+;;    parsec-lookahead           lookahead         try parser and consume no 
input when successful
+;;    parsec-peek                try && lookahead  try parser without 
comsuming any input
+;;    parsec-peek-p              try && lookahead  same as parsec-peek except 
the return value for failure
 ;;    parsec-with-error-message  <?> (similar)     use the new error message 
when an error occurs
 ;;    parsec-many                many              apply the parser zero or 
more times
 ;;    parsec-many1               many1             apply the parser one or 
more times