Skip to content
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.

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

Misc suggestions for section 2.7 - 2.10 #35

Closed
7 tasks done
RBastianini opened this issue Aug 31, 2020 · 3 comments
Closed
7 tasks done

Misc suggestions for section 2.7 - 2.10 #35

RBastianini opened this issue Aug 31, 2020 · 3 comments
Labels
📚 PML EN English version of the PML Specs document 💀 bug Something isn't working 💀 typos Problems with the PML text contents.

Comments

@RBastianini
Copy link

RBastianini commented Aug 31, 2020

  • In §2.7 the secondary sentence of the first paragraph is missing the subject

    Many spoken languages allow changing the order of some words (or groups of words) in a sentence without altering its original meaning; likewise, at a macroscopic level, sometimes is possible to swap the order of sentences within a phrase.

    should instead be

    Many spoken languages allow changing the order of some words (or groups of words) in a sentence without altering its original meaning; likewise, at a macroscopic level, sometimes it is possible to swap the order of sentences within a phrase.

  • (REJECTED) In the following sentence, the order of words can be altered for a more natural flow:

    To avoid writing each and every variation of a sequence in which some atoms swap positions, you can enclose within curly brackets { and } the subproductions that need to be permutated.

    To avoid writing each and every variation of a sequence in which some atoms swap positions, you can enclose the subproductions that need to be permutated within curly brackets { and }.

  • I believe that the two following examples are incorrect. They are syntactically acceptable, but they do not produce the expected results, due to the use of unquoted commas ,.

    S ::= {in 10 minutes}^, {at 3 o'clock}^, {"I" {will depart} {alone}} ;
    

    should instead be

    S ::= {in 10 minutes}^"," {at 3 o'clock}^"," {"I" {will depart} {alone}} ;
    

    and

    S ::= {in 10 minutes}^, {at 3 o'clock}^, ("I" {will depart} {alone}) ;
    

    should instead be

    S ::= {in 10 minutes}^"," {at 3 o'clock}^"," ("I" {will depart} {alone}) ;
    

    We can remove some of the punctuation signs by using dashes in place of commas, so we at least don't require to concatenate them to the preceding word, such as

    S ::= {in 10 minutes} "-" {at 3 o'clock} "-" {"I" {will depart} {alone}} ;
    

    and

    S ::= {in 10 minutes} "-" {at 3 o'clock} "-" ("I" {will depart} {alone}) ;
    
  • In §2.10, the first sentence can be rewritten in order to facilitate the reader:

    Binding is, in general, a declarative construct that associates a series of productions to a non terminal symbol. Each binding introduces in the environment (see section 2.11) that association, and every production generated in that environment can refer to its non terminal symbol.

    Binding is, in general, a declarative construct that associates a series of productions to a non terminal symbol. Each binding introduces that association in the environment where it is declared (see section 2.11), and every production generated in that environment can refer to its non terminal symbol.

  • The two ending sentences in §2.10.1 can also be tweaked:

    The production associated to Fruit does not undergo an immediate production but is closed together with the current environment according to scoping rules.

    The production associated to Fruit does not undergo an immediate generation but is closed together with the current environment according to scoping rules.

  • Also, there's a typo: occurence -> occurrence (actually this one is repeated a few times in the following paragraphs, consider doing a bulk replace).

  • In §2.10.2, I would personally replace the words in bold a single time with just once.

@tajmone tajmone added this to the PML Spec EN v1.1.1 milestone Sep 1, 2020
@tajmone tajmone added 📚 PML EN English version of the PML Specs document 💀 typos Problems with the PML text contents. 💀 style errors Problematic text styling that need to be fixed 💀 bug Something isn't working and removed 💀 style errors Problematic text styling that need to be fixed labels Sep 1, 2020
@tajmone
Copy link
Owner

tajmone commented Sep 1, 2020

We can remove some of the punctuation signs by using dashes in place of commas, so we at least don't require to concatenate them to the preceding word

The problem is that we'd be replacing the commas with the minus sign - and not a real em-dash , which would be a punctuation error. And I'm not sure how Polygen handles em-dashes in source files, due to the char (151) being outside the ASCII range, which makes it problematic if the source file is being encoded as UTF-8 (for it would be represented by a two code points sequence). If we stick to plain ASCII characters we avoid presenting the reader with examples that could lead to encoding problems (specially with beginners).

Unfortunately, in many modern editors and IDEs it's quite hard to work with ASCII/ISO-8859-1 encoding, for they easily break it and switch to UTF-8 if you paste some contents from an UTF-8 document (instead of converting the clipboard to ISO-8859-1). So, I suggest keeping the commas to avoid similar issues.

@tajmone
Copy link
Owner

tajmone commented Sep 9, 2020

In the following sentence, the order of words can be altered for a more natural flow:

To avoid writing each and every variation of a sequence in which some atoms swap positions, you can enclose within curly brackets { and } the subproductions that need to be permutated.

To avoid writing each and every variation of a sequence in which some atoms swap positions, you can enclose the subproductions that need to be permutated within curly brackets { and }.

Although the latter flows slightly better it introduces some semantic ambiguity, which causes some degree of strain on the reader to resolve it.

tajmone added a commit that referenced this issue Sep 9, 2020
As suggested by @RBastianini, Fix various typos, improve readability of
some sentences and fix two examples in "§2.7 Permutation". (fixes #35)
@tajmone
Copy link
Owner

tajmone commented Sep 9, 2020

The commas problem in §2.7, mentioned by @RBastianini, also affects the Italian document; so I've created an issue for it: #37

@tajmone tajmone closed this as completed Sep 9, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📚 PML EN English version of the PML Specs document 💀 bug Something isn't working 💀 typos Problems with the PML text contents.
Projects
None yet
Development

No branches or pull requests

2 participants