summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJesse Luehrs <doy@tozt.net>2013-07-23 19:01:23 -0400
committerJesse Luehrs <doy@tozt.net>2013-07-23 19:01:23 -0400
commitff9757bcc175ff94456c28183b0ca10273c1023b (patch)
treeef902aeccf344685c513e9a70d622cd3a7aec22e
parent60b8b4ddf6ce5280991a87fe3947aa769bf9cb8b (diff)
downloadparse-keyword-ff9757bcc175ff94456c28183b0ca10273c1023b.tar.gz
parse-keyword-ff9757bcc175ff94456c28183b0ca10273c1023b.zip
document passing in the keyword name
-rw-r--r--lib/Parse/Keyword.pm10
1 files changed, 5 insertions, 5 deletions
diff --git a/lib/Parse/Keyword.pm b/lib/Parse/Keyword.pm
index d424d51..e0bb3f9 100644
--- a/lib/Parse/Keyword.pm
+++ b/lib/Parse/Keyword.pm
@@ -58,11 +58,11 @@ should be used to implement the custom parsing behavior.
The parsing coderefs will be called when perl encounters a call to the keyword
that you attached custom parsing to. The current parser state will be directly
-after parsing the keyword. Your parser function should return a coderef which,
-when called at runtime, will produce the arguments to the function. In
-addition, if your keyword should be parsed as a statement (for instance, if you
-don't want to require a trailing semicolon), you can return a second, true
-value.
+after parsing the keyword. The parser function will receive the name of the
+keyword as a parameter, and should return a coderef which, when called at
+runtime, will produce the arguments to the function. In addition, if your
+keyword should be parsed as a statement (for instance, if you don't want to
+require a trailing semicolon), you can return a second, true value.
In order to actually handle the parsing itself, this module also exports
various parsing functions, which you can call. See below for details.