Unabbreviation of Haskell's grammar tokens for readability

Previous Topic Next Topic
 
classic Classic list List threaded Threaded
5 messages Options
Reply | Threaded
Open this post in threaded view
|

Unabbreviation of Haskell's grammar tokens for readability

Solomon Ucko
In the Haskell 1998 & 2010 reports, I found the names of the tokens for Haskell's lexical structure / syntax / grammar very hard to read, as they were highly abbreviated. I might get more familiar with them, but that doesn't help newcomers, like me now. Anyone mind if I change them to use full words? Mind if I separate the words with underscores? I made a few changes with simple find & replace, and it made it so much more readable. It did make the lines longer (duh!), but I see no reason for that to be much of a problem. Or would horizontal scroll and/or line-wrapping be too much of an issue? Where would the changes go, anyways?

Another thing that would be useful but could be harder to implement would be links from usages to declarations of tokens.

Thanks,
Solomon Ucko

P.S. Please let me know if this has come up before, as I have just joined this list.

_______________________________________________
Haskell-prime mailing list
[hidden email]
http://mail.haskell.org/cgi-bin/mailman/listinfo/haskell-prime
Reply | Threaded
Open this post in threaded view
|

Re: Unabbreviation of Haskell's grammar tokens for readability

Mario Blažević
On 2019-04-06 10:36 p.m., Solomon Ucko wrote:
> In the Haskell 1998 & 2010 reports, I found the names of the tokens for
> Haskell's lexical structure / syntax / grammar very hard to read, as
> they were highly abbreviated. I might get more familiar with them, but
> that doesn't help newcomers, like me now. Anyone mind if I change them
> to use full words? Mind if I separate the words with underscores? I made
> a few changes with simple find & replace, and it made it so much more
> readable. It did make the lines longer (duh!), but I see no reason for
> that to be much of a problem. Or would horizontal scroll and/or
> line-wrapping be too much of an issue? Where would the changes go, anyways?

        If the idea is to submit the changes for the next version of the
Haskell report, they would eventually have to be submitted as a GitHub
pull request against https://github.com/haskell/rfcs - the key word
being eventually. You should first create a proposal with the
explanation of the changes you want and have it accepted.


> Another thing that would be useful but could be harder to implement
> would be links from usages to declarations of tokens.
>
> Thanks,
> Solomon Ucko
>
> P.S. Please let me know if this has come up before, as I have just
> joined this list.
>
_______________________________________________
Haskell-prime mailing list
[hidden email]
http://mail.haskell.org/cgi-bin/mailman/listinfo/haskell-prime
Reply | Threaded
Open this post in threaded view
|

Re: Unabbreviation of Haskell's grammar tokens for readability

Solomon Ucko
Thanks for pointing me to the repo. I'll work on the proposal when I get a chance, but it sounds like it'll probably take a while anyways.

Thanks,
Solomon Ucko

On Mon, Apr 8, 2019, 12:41 Mario Blažević <[hidden email]> wrote:
On 2019-04-06 10:36 p.m., Solomon Ucko wrote:
> In the Haskell 1998 & 2010 reports, I found the names of the tokens for
> Haskell's lexical structure / syntax / grammar very hard to read, as
> they were highly abbreviated. I might get more familiar with them, but
> that doesn't help newcomers, like me now. Anyone mind if I change them
> to use full words? Mind if I separate the words with underscores? I made
> a few changes with simple find & replace, and it made it so much more
> readable. It did make the lines longer (duh!), but I see no reason for
> that to be much of a problem. Or would horizontal scroll and/or
> line-wrapping be too much of an issue? Where would the changes go, anyways?

        If the idea is to submit the changes for the next version of the
Haskell report, they would eventually have to be submitted as a GitHub
pull request against https://github.com/haskell/rfcs - the key word
being eventually. You should first create a proposal with the
explanation of the changes you want and have it accepted.


> Another thing that would be useful but could be harder to implement
> would be links from usages to declarations of tokens.
>
> Thanks,
> Solomon Ucko
>
> P.S. Please let me know if this has come up before, as I have just
> joined this list.
>
_______________________________________________
Haskell-prime mailing list
[hidden email]
http://mail.haskell.org/cgi-bin/mailman/listinfo/haskell-prime

_______________________________________________
Haskell-prime mailing list
[hidden email]
http://mail.haskell.org/cgi-bin/mailman/listinfo/haskell-prime
Reply | Threaded
Open this post in threaded view
|

Re: Unabbreviation of Haskell's grammar tokens for readability

Solomon Ucko
I have now submitted a pull request with a RFC: https://github.com/haskell/rfcs/pull/25.

Solomon Ucko

On Mon, Apr 8, 2019 at 3:14 PM Solomon Ucko <[hidden email]> wrote:
Thanks for pointing me to the repo. I'll work on the proposal when I get a chance, but it sounds like it'll probably take a while anyways.

Thanks,
Solomon Ucko

On Mon, Apr 8, 2019, 12:41 Mario Blažević <[hidden email]> wrote:
On 2019-04-06 10:36 p.m., Solomon Ucko wrote:
> In the Haskell 1998 & 2010 reports, I found the names of the tokens for
> Haskell's lexical structure / syntax / grammar very hard to read, as
> they were highly abbreviated. I might get more familiar with them, but
> that doesn't help newcomers, like me now. Anyone mind if I change them
> to use full words? Mind if I separate the words with underscores? I made
> a few changes with simple find & replace, and it made it so much more
> readable. It did make the lines longer (duh!), but I see no reason for
> that to be much of a problem. Or would horizontal scroll and/or
> line-wrapping be too much of an issue? Where would the changes go, anyways?

        If the idea is to submit the changes for the next version of the
Haskell report, they would eventually have to be submitted as a GitHub
pull request against https://github.com/haskell/rfcs - the key word
being eventually. You should first create a proposal with the
explanation of the changes you want and have it accepted.


> Another thing that would be useful but could be harder to implement
> would be links from usages to declarations of tokens.
>
> Thanks,
> Solomon Ucko
>
> P.S. Please let me know if this has come up before, as I have just
> joined this list.
>
_______________________________________________
Haskell-prime mailing list
[hidden email]
http://mail.haskell.org/cgi-bin/mailman/listinfo/haskell-prime

_______________________________________________
Haskell-prime mailing list
[hidden email]
http://mail.haskell.org/cgi-bin/mailman/listinfo/haskell-prime
Reply | Threaded
Open this post in threaded view
|

Re: Unabbreviation of Haskell's grammar tokens for readability

Solomon Ucko
In reply to this post by Solomon Ucko
The HTML version might do either with the tables, though. It might also change.

Also, wouldn't the PR page be a better place to discuss these issues?

On Tue, Apr 9, 2019, 03:02 Antonio Nikishaev <[hidden email]> wrote:

> On 7 Apr 2019, at 6:36, Solomon Ucko <[hidden email]> wrote:
>
> In the Haskell 1998 & 2010 reports, I found the names of the tokens for Haskell's lexical structure / syntax / grammar very hard to read, as they were highly abbreviated. I might get more familiar with them, but that doesn't help newcomers, like me now. Anyone mind if I change them to use full words? Mind if I separate the words with underscores? I made a few changes with simple find & replace, and it made it so much more readable. It did make the lines longer (duh!), but I see no reason for that to be much of a problem. Or would horizontal scroll and/or line-wrapping be too much of an issue? Where would the changes go, anyways?

There is no scrolling in PDF.



_______________________________________________
Haskell-prime mailing list
[hidden email]
http://mail.haskell.org/cgi-bin/mailman/listinfo/haskell-prime