Re: Is referring to GHC-proposals in GHC user manual bad practice or not?

2021-03-17 Thread Richard Eisenberg
> On Mar 17, 2021, at 2:52 PM, Oleg Grenrus wrote: > > > Do we agree on this interpretation? Yes, fully. Thanks for illustrating with examples. Richard > > - Oleg > > On 17.3.2021 20.35, Richard Eisenberg wrote: >> My vote is that the manual should be self-standing. References to

Re: Is referring to GHC-proposals in GHC user manual bad practice or not?

2021-03-17 Thread Ben Gamari
I, too, agree with Richard here. In fact, one (small) reason why we originally chose RestructuredText as the proposal syntax is to make it easy to turn the proposal into users guide documentation. Cheers, - Ben On March 17, 2021 2:35:54 PM EDT, Richard Eisenberg wrote: >My vote is that the

Re: Is referring to GHC-proposals in GHC user manual bad practice or not?

2021-03-17 Thread Oleg Grenrus
To check that I understand this - Bad: "See the proposal for the definition of a closing token" (important definition) - Acceptable: "The reasons for this ..." (not essential information for replicating the functionality, though maybe one sentence summary would be good?) - Fine: "...the

Re: Is referring to GHC-proposals in GHC user manual bad practice or not?

2021-03-17 Thread Viktor Dukhovni
> On Mar 17, 2021, at 2:35 PM, Richard Eisenberg wrote: > > My vote is that the manual should be self-standing. References to proposals > are good, but as supplementary/background reading only. My gold standard > always is: if we lost all the source code to GHC and all its compiled >

Re: Is referring to GHC-proposals in GHC user manual bad practice or not?

2021-03-17 Thread Brandon Allbery
I'm inclined to agree with this, especially given the argument that it'll depend on the state of a proposal at a given time. On Wed, Mar 17, 2021 at 2:36 PM Richard Eisenberg wrote: > My vote is that the manual should be self-standing. References to > proposals are good, but as

Re: Is referring to GHC-proposals in GHC user manual bad practice or not?

2021-03-17 Thread Richard Eisenberg
My vote is that the manual should be self-standing. References to proposals are good, but as supplementary/background reading only. My gold standard always is: if we lost all the source code to GHC and all its compiled versions, but just had the manual and Haskell Reports (but without external

Re: Is referring to GHC-proposals in GHC user manual bad practice or not?

2021-03-17 Thread Oleg Grenrus
I forgot to link a bit of relevant discussion from https://github.com/ghc-proposals/ghc-proposals/pull/406, is there a (silent) consensus on the issue? - Oleg On 17.3.2021 19.15, Oleg Grenrus wrote: > I have a following question: > My lexer rules related proposal was recently accepted. The

Is referring to GHC-proposals in GHC user manual bad practice or not?

2021-03-17 Thread Oleg Grenrus
I have a following question: My lexer rules related proposal was recently accepted. The biggest part of getting it in is writing documentation for it. While looking at Divergence from Haskell 98 and Haskell 2010 section of the user manual, in particular Lexical syntax, it already has See "GHC