Skip to content

Docs: Clarify BNF description in "introduction.rst" #14492

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
aeros wants to merge 2 commits into from
Closed

Docs: Clarify BNF description in "introduction.rst" #14492

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
781418f
BNF description fix
aeros Jul 1, 2019
ec90e53
Added suggestion from taleinat
aeros Jul 1, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
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.
  • Loading branch information
@aeros
aeros authored Jul 1, 2019
commit 781418fc322a6e13cc4bb44938231d16af32d005
2 changes: 1 addition & 1 deletion Doc/reference/introduction.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.)

Expand Down