-
Notifications
You must be signed in to change notification settings - Fork 0
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
Comments
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. |
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. |
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. |
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)
OK, fatto! Spero che il testo della nota vada bene. Nell'inglese:
Nell'italiano:
|
In "§2.7 Permutation", add an Alert block to clarify the syntactical differences between two very similar examples. (See #8)
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}} ;
):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.
The text was updated successfully, but these errors were encountered: