unofficial mirror of guile-devel@gnu.org 
 help / color / mirror / Atom feed
From: Noah Lavine <noah.b.lavine@gmail.com>
To: guile-devel@gnu.org
Subject: [PATCH] LALR Parser Documentation Fix
Date: Tue, 26 Oct 2010 21:46:23 -0400	[thread overview]
Message-ID: <AANLkTim2abW3evJy2ZwW__KGCjD3w6yvx1zYzHaAdiXn@mail.gmail.com> (raw)

The documentation for the LALR parser currently says that the
tokenizer procedure passed to the parser should be a unary procedure
taking a port, but the documentation at
http://code.google.com/p/lalr-scm/wiki/ParserDefinition says it should
be a thunk. The following patch fixes this:

Noah

diff --git a/doc/ref/api-lalr.texi b/doc/ref/api-lalr.texi
index e19614c..95b0a85 100644
--- a/doc/ref/api-lalr.texi
+++ b/doc/ref/api-lalr.texi
@@ -25,12 +25,12 @@ Each rule has the form @code{(@var{non-terminal} (@var{rhs}
 right-hand sides, i.e., the production rule, and @var{action} is a semantic
 action associated with the rule.

-The generated parser is a two-argument procedure that takes a @dfn{tokenizer}
-and a @dfn{syntax error procedure}.  The tokenizer should be a unary procedure
-taking a port and returning a lexical token as produced by
-@code{make-lexical-token}.  The syntax error procedure may be called with at
-least an error message (a string), and optionally the lexical token that caused
-the error.
+The generated parser is a two-argument procedure that takes a
+@dfn{tokenizer} and a @dfn{syntax error procedure}.  The tokenizer
+should be a thunk that returns lexical tokens as produced by
+@code{make-lexical-token}.  The syntax error procedure may be called
+with at least an error message (a string), and optionally the lexical
+token that caused the error.
 @end deffn

 Please refer to the @code{lalr-scm} documentation for details.



             reply	other threads:[~2010-10-27  1:46 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2010-10-27  1:46 Noah Lavine [this message]
2010-10-27 22:05 ` [PATCH] LALR Parser Documentation Fix Ludovic Courtès

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.gnu.org/software/guile/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=AANLkTim2abW3evJy2ZwW__KGCjD3w6yvx1zYzHaAdiXn@mail.gmail.com \
    --to=noah.b.lavine@gmail.com \
    --cc=guile-devel@gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).