From 781418fc322a6e13cc4bb44938231d16af32d005 Mon Sep 17 00:00:00 2001 From: Kyle Stanley Date: Sun, 30 Jun 2019 20:59:50 -0400 Subject: [PATCH 1/2] BNF description fix In the following section "name: `lc_letter` (`lc_letter` | "_")*" the section states "a ``name`` is an ``lc_letter`` followed by a sequence of zero or more ``lc_letter``\ s and underscores" there is an issue with the usage of "and" in "``lc_letter``\ s and underscores". While this usage of "and" is not grammatically incorrect in English context, if interpreted by the reader literally in the context of the notation, "``lc_letter``\ s and underscores" would directly translate to (`lc_letter` & "_"), which would entirely change the meaning of that line. Therefore, I would suggest changing "``lc_letter``\ s and underscores" to "``lc_letter``\ s or underscores". Usually I would consider a change to a single word a very minor commit, but a single word can entirely change the meaning in this context. --- Doc/reference/introduction.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Doc/reference/introduction.rst b/Doc/reference/introduction.rst index bb7e3906dba607..7903dff63141ac 100644 --- a/Doc/reference/introduction.rst +++ b/Doc/reference/introduction.rst @@ -98,7 +98,7 @@ notation. This uses the following style of definition: lc_letter: "a"..."z" The first line says that a ``name`` is an ``lc_letter`` followed by a sequence -of zero or more ``lc_letter``\ s and underscores. An ``lc_letter`` in turn is +of zero or more ``lc_letter``\ s or underscores. An ``lc_letter`` in turn is any of the single characters ``'a'`` through ``'z'``. (This rule is actually adhered to for the names defined in lexical and grammar rules in this document.) From ec90e5354fc840cc94991af38a2bf91a5d5458df Mon Sep 17 00:00:00 2001 From: Kyle Stanley Date: Mon, 1 Jul 2019 06:57:27 -0400 Subject: [PATCH 2/2] Added suggestion from taleinat Improve the clarity by changing ``or`` to ``and/or``. This simultaneously satisfies the logical operation and English contexts. --- Doc/reference/introduction.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Doc/reference/introduction.rst b/Doc/reference/introduction.rst index 7903dff63141ac..37706c69870ab3 100644 --- a/Doc/reference/introduction.rst +++ b/Doc/reference/introduction.rst @@ -98,7 +98,7 @@ notation. This uses the following style of definition: lc_letter: "a"..."z" The first line says that a ``name`` is an ``lc_letter`` followed by a sequence -of zero or more ``lc_letter``\ s or underscores. An ``lc_letter`` in turn is +of zero or more ``lc_letter``\ s and/or underscores. An ``lc_letter`` in turn is any of the single characters ``'a'`` through ``'z'``. (This rule is actually adhered to for the names defined in lexical and grammar rules in this document.)