Commits

Volker Birk  committed 00e6d46

documentation improvements

  • Participants
  • Parent commits bf9644f

Comments (0)

Files changed (5)

File docs/grammar_elements.en.yhtml2

         `w "Terminal_and_nonterminal_symbols" > Terminal Symbol`.
         It is removed and no result is put into the ∫Abstract syntax tree∫.
         If it does not exist at the correct position in the source text,
-        a «SyntaxError» ist generated.
+        a «SyntaxError» is raised.
         >>
 
     p > Example:
         the «pypeg2.RegEx» encapsulation.  Regular Expressions are parsed as
         `w "Terminal_and_nonterminal_symbols" > Terminal Symbols`. The matching 
         result is put into the AST. If no match can be achieved, a 
-        «SyntaxError» is generated.
+        «SyntaxError» is raised.
         >>
 
     p   >>
     p   >>
         A «tuple» or an instance of «pypeg2.Concat» specifies, that different
         things have to be parsed one after another. If not all of them parse in
-        their sequence, a «SyntaxError» is generated.
+        their sequence, a «SyntaxError» is raised.
         >>
 
     p > Example:
         A «list» instance which is not derived from «pypeg2.Concat» represents
         different options. They're tested in their sequence. The first option
         which parses is chosen, the others are not tested any more. If none
-        matches, a «SyntaxError» is generated.
+        matches, a «SyntaxError» is raised.
         >>
 
     p > Example:
     p   >>
         A class which is derived from «Symbol» can have an «Enum» as its
         «grammar» only. Other values for its «grammar» are forbidden and will
-        generate a «TypeError». If such an «Enum» is specified, each parsed
-        value will be checked if being a member of this «Enum» additionally to
-        the «RegEx» matching.
+        raise a «TypeError». If such an «Enum» is specified, each parsed value
+        will be checked if being a member of this «Enum» additionally to the
+        «RegEx» matching.
         >>
 
     h4 > Class variables
 
     p   >>
         A «List» is parsed by following its «grammar». If a «List» is parsed,
-        then all things which are parsed and which are not attributes are being
+        then all things which are parsed and which are not attributes are
         appended to the «List».
         >>
 
 
     p   >>
         Initialize an OrderedDict containing the data of the Namespace.
-        Arguments are being put into the Namespace, keyword arguments give the
+        Arguments are put into the Namespace, keyword arguments give the
         attributes of the Namespace.
         >>
 
     p   >>
         A «Namespace» is parsed by following its «grammar». If a «Namespace» is
         parsed, then all things which are parsed and which are not attributes
-        are being appended to the «Namespace» and indexed by their «name»
+        are appended to the «Namespace» and indexed by their «name»
         attribute.
         >>
 
     p > «Enum(Namespace)»
 
     p   >>
-        A Namespace which is being treated as an Enum. Enums can only contain
+        A Namespace which is treated as an Enum. Enums can only contain
         «Keyword» or «Symbol» instances. An «Enum» cannot be modified after
         creation. An «Enum» is allowed as the grammar of a «Symbol» only.
         >>
     p   >>
         An «Enum» is parsed as a selection for possible values for a «Symbol».
         If a value is parsed which is not member of the «Enum», a «SyntaxError»
-        is generated.
+        is raised.
         >>
 
     p > Example:
 
     p   >>
         Composing «some()» composes as many things as there are, but at least
-        one. If there is no matching thing, a «ValueError» is generated.
+        one. If there is no matching thing, a «ValueError» is raised.
         >>
 
     p > Example:

File docs/heading.en.yinc2

 div id="headline" {
     p > pyPEG – a PEG Parser-Interpreter in Python
     div class="small" {
-        "pyPEG 2.11.0 of Fr May 03 2013 – Copyleft 2009-2013, "
+        "pyPEG 2.11.1 of Sa May 04 2013 – Copyleft 2009-2013, "
         a "http://fdik.org", "Volker Birk";
     }
     div id=python1 p

File docs/index.en.yhtml2

     }
 
     p   >>
-        Such a Callback Function is being called with two arguments. The first 
-        argument is the object to output. The second argument is the parser object
-        to get state information of the composing process. Because this fits
-        the convention for Python methods, you can write it as a method of the
-        class where it belongs to.
+        Such a Callback Function is called with two arguments. The first
+        argument is the object to output. The second argument is the parser
+        object to get state information of the composing process. Because this
+        fits the convention for Python methods, you can write it as a method of
+        the class where it belongs to.
         >>
 
     p   >>

File docs/parser_engine.en.yhtml2

     h4 > Arguments
 
     glossary {
-        term "thing" > thing for which cache memory is cleared
+        term "thing" > thing for which cache memory is cleared; default: «None»
     }
 
     h3 id=parser_parse > Method parse()
         >>
 
     p   >>
-        This method parses as far as possible. It does not generate a
+        This method parses as far as possible. It does not raise a
         «SyntaxError» if the source «text» does not parse completely. It
         returns a «SyntaxError» object as «result» part of the return value if
         the beginning of the source «text» does not comply with grammar
 from distutils.core import setup
 
-_version = '2.11.0'
+_version = '2.11.1'
 
 setup(
     name='pyPEG2',