From 9d880b6f54aa2ee193fccdb1242a52923df8c8aa Mon Sep 17 00:00:00 2001
From: Carl Friedrich Bolz-Tereick <cfbolz@gmx.de>
Date: Fri, 19 Nov 2021 22:16:43 +0100
Subject: [PATCH] =?UTF-8?q?Improvements=20to=20"Guide=20to=20CPython?=
 =?UTF-8?q?=E2=80=99s=20Parser"=20(#763)?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

* put references to names from rules into ``backticks``

* two typos

* mention that ~ is called "the cut"

(The grammar gives that name, and I as a prolog programmer was looking
for the terminology ;-))
---
 parser.rst | 25 +++++++++++++------------
 1 file changed, 13 insertions(+), 12 deletions(-)

diff --git a/parser.rst b/parser.rst
index 06434fc57b..6001051a6d 100644
--- a/parser.rst
+++ b/parser.rst
@@ -169,7 +169,7 @@ Python-style comments.
 ``e1 e2``
 '''''''''
 
-Match e1, then match e2.
+Match ``e1``, then match ``e2``.
 
 ::
 
@@ -178,7 +178,7 @@ Match e1, then match e2.
 ``e1 | e2``
 '''''''''''
 
-Match e1 or e2.
+Match ``e1`` or ``e2``.
 
 The first alternative can also appear on the line after the rule name
 for formatting purposes. In that case, a \| must be used before the
@@ -193,7 +193,7 @@ first alternative, like so:
 ``( e )``
 '''''''''
 
-Match e.
+Match ``e``.
 
 ::
 
@@ -209,7 +209,7 @@ operator together with the repeat operators:
 ``[ e ] or e?``
 '''''''''''''''
 
-Optionally match e.
+Optionally match ``e``.
 
 ::
 
@@ -225,7 +225,7 @@ optional:
 ``e*``
 ''''''
 
-Match zero or more occurrences of e.
+Match zero or more occurrences of ``e``.
 
 ::
 
@@ -234,7 +234,7 @@ Match zero or more occurrences of e.
 ``e+``
 ''''''
 
-Match one or more occurrences of e.
+Match one or more occurrences of ``e``.
 
 ::
 
@@ -243,7 +243,7 @@ Match one or more occurrences of e.
 ``s.e+``
 ''''''''
 
-Match one or more occurrences of e, separated by s. The generated parse
+Match one or more occurrences of ``e``, separated by ``s``. The generated parse
 tree does not include the separator. This is otherwise identical to
 ``(e (s e)*)``.
 
@@ -256,14 +256,14 @@ tree does not include the separator. This is otherwise identical to
 
 .. _peg-positive-lookahead:
 
-Succeed if e can be parsed, without consuming any input.
+Succeed if ``e`` can be parsed, without consuming any input.
 
 ``!e``
 ''''''
 
 .. _peg-negative-lookahead:
 
-Fail if e can be parsed, without consuming any input.
+Fail if ``e`` can be parsed, without consuming any input.
 
 An example taken from the Python grammar specifies that a primary
 consists of an atom, which is not followed by a ``.`` or a ``(`` or a
@@ -276,14 +276,15 @@ consists of an atom, which is not followed by a ``.`` or a ``(`` or a
 ``~``
 ''''''
 
-Commit to the current alternative, even if it fails to parse.
+Commit to the current alternative, even if it fails to parse (this is called
+the "cut").
 
 ::
 
     rule_name: '(' ~ some_rule ')' | some_alt
 
 In this example, if a left parenthesis is parsed, then the other
-alternative won’t be considered, even if some_rule or ‘)’ fail to be
+alternative won’t be considered, even if some_rule or ``)`` fail to be
 parsed.
 
 Left recursion
@@ -343,7 +344,7 @@ inside curly-braces, which specifies the return value of the alternative::
         | first_alt1 first_alt2 { first_alt1 }
         | second_alt1 second_alt2 { second_alt1 }
 
-If the action is ommited, a default action is generated: 
+If the action is omitted, a default action is generated:
 
 * If there's a single name in the rule, it gets returned.