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

PML: Improve Permutation Examples in §2.7 #8

Closed
tajmone opened this issue Aug 15, 2020 · 4 comments
Closed

PML: Improve Permutation Examples in §2.7 #8

tajmone opened this issue Aug 15, 2020 · 4 comments
Labels
📚 PML EN English version of the PML Specs document 📚 PML IT Italian version of the PML Specs document 💡 enhancement A new feature or enhancement request/proposal

Comments

@tajmone
Copy link
Owner

tajmone commented Aug 15, 2020

In §2.7 Permutation of both the English and Italian PML docs, two consecutive examples tend to appear to have identical Polygen sources, whereas in fact the second example employs round braces instead of curly ones (i.e. ("I" {will depart} {alone}) ; vs {"I" {will depart} {alone}} ;):

EXAMPLE

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

PRODUCES

in 10 minutes, at 3 o'clock, I will depart alone
at 3 o'clock, in 10 minutes, I will depart alone
in 10 minutes, I will depart alone, at 3 o'clock
at 3 o'clock, I will depart alone, in 10 minutes
I will depart alone, in 10 minutes, at 3 o'clock
I will depart alone, at 3 o'clock, in 10 minutes
in 10 minutes, at 3 o'clock, I alone will depart
at 3 o'clock, in 10 minutes, I alone will depart
in 10 minutes, I alone will depart, at 3 o'clock
at 3 o'clock, I alone will depart, in 10 minutes
I alone will depart, in 10 minutes, at 3 o'clock
I alone will depart, at 3 o'clock, in 10 minutes

EXAMPLE

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

in 10 minutes, at 3 o'clock, I will depart alone
at 3 o'clock, in 10 minutes, I will depart alone
in 10 minutes, at 3 o'clock, I alone will depart
at 3 o'clock, in 10 minutes, I alone will depart

Since it's quite possible that the average reader might not detect the subtle difference between the use of round/curly braces in the two source examples (they look similar, especially with medium font sizes) it might be worth adding an explicit note to highlight the difference between the two examples.

@tajmone tajmone added 💡 enhancement A new feature or enhancement request/proposal 📚 PML EN English version of the PML Specs document 📚 PML IT Italian version of the PML Specs document labels Aug 15, 2020
@tajmone tajmone changed the title PML: Improve Example in §2.7? PML: Improve Permutation Examples in §2.7 Aug 15, 2020
@tajmone
Copy link
Owner Author

tajmone commented Aug 16, 2020

Che ne pensi @alvisespano?

Sebbene si tratta solo di un dettaglio, mi rendo conto che ogni volta che rileggo quella sezione ci metto qualche minuto ad accorgermi della presenza di parentesi tonde nel secondo sorgente, e trarre un senso dal secondo esempio.

Questo avviene nonostante abbia letto e riletto il documento più e più volte, in entrambe le lingue, quindi immagino che per chi legge il documento la prima volta debba essere ancor più difficile cogliere la differenza tra i due esempi — soprattutto perché le parentesi grafe sono molto simili a quelle tonde nei font monospace, a quelle dimensioni di carattere.

Aggiungere una frase di avvertimento che indichi al lettore l'uso di parentesi differenti nei due esempi ci costerebbe poco e nulla, ma potrebbe fare una grande differenza per il lettore.

@tajmone tajmone removed this from the PML Spec v1.1.1 (EN+IT) milestone Sep 9, 2020
@tajmone tajmone added this to To do in PML Docs Revision via automation Sep 9, 2020
@alvisespano
Copy link
Collaborator

Sono d'accordo con te: non è così chiaro. Cambiare esempio non è semplice: è praticamente un minimal example. Come dici tu, conviene spiegare meglio nel testo: sottolineare che sono graffe quelle parentesi; e nel secondo esempio rimarcare che sono tonde quelle più a destra.

@tajmone
Copy link
Owner Author

tajmone commented Sep 11, 2020

Ottimo, allora provvedo subito. Magari uso uno degli appositi blocchi per le note, che sono carini da vedere e, al contempo, sono un "contenuto laterale" al testo.

@tajmone tajmone removed this from To do in PML Docs Revision Sep 11, 2020
@tajmone tajmone added this to the PML Spec v1.1.1 (EN+IT) milestone Sep 11, 2020
@tajmone tajmone added the 🕑 pending task Approved changes waiting to be implemented label Sep 11, 2020
tajmone added a commit that referenced this issue Sep 12, 2020
In "§2.7 Permutazioni" aggiungi un Alert block per evidenziare le
differenze sintattiche tra due esempi che possono sembrare identici,
ma non lo sono. (See #8)
@tajmone
Copy link
Owner Author

tajmone commented Sep 12, 2020

OK, fatto!

Spero che il testo della nota vada bene.


Nell'inglese:

BEWARE! — The two examples below might look the same at first glance, but their endings are different:

  • the first example uses braces:
    • {"I" {will depart} {alone}} ;
  • the other one uses parentheses:
    • ("I" {will depart} {alone}) ;

Nell'italiano:

ATTENZIONE! — I due esempi che seguono posso sembrare identici di primo acchito, ma differiscono nella parte finale:

  • il primo impiega parentesi graffe:
    • {{io} {partiro'} solo} ;
  • il secondo parentesi tonde:
    • ({io} {partiro'} solo) ;

@tajmone tajmone closed this as completed Sep 12, 2020
tajmone added a commit that referenced this issue Sep 12, 2020
In "§2.7 Permutation", add an Alert block to clarify the syntactical
differences between two very similar examples. (See #8)
@tajmone tajmone removed the 🕑 pending task Approved changes waiting to be implemented label Sep 12, 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 📚 PML IT Italian version of the PML Specs document 💡 enhancement A new feature or enhancement request/proposal
Projects
None yet
Development

No branches or pull requests

2 participants