Suggestion for GHC System User's Guide documentation change
p.k.f.holzenspies at utwente.nl
p.k.f.holzenspies at utwente.nl
Mon Aug 25 08:42:15 UTC 2014
Dear Howard,
Yes, emphatically so! Any examples should be copy-paste-runnable if reasonably possible without any further switches, so that means the pragmas *should* be included!
Regards,
Philip
________________________________________
From: Howard B. Golden <howard_b_golden at yahoo.com>
Sent: 22 August 2014 18:47
To: Holzenspies, P.K.F. (EWI); simonpj at microsoft.com; ghc-devs at haskell.org
Subject: Re: Suggestion for GHC System User's Guide documentation change
p.k.f.,
I like your less verbose suggestion better than my original.
I don't understand your comment about code examples: Are you supporting or opposing the inclusion of the LANGUAGE pragmas in the examples?
Howard
________________________________
From: "p.k.f.holzenspies at utwente.nl" <p.k.f.holzenspies at utwente.nl>
To: simonpj at microsoft.com; howard_b_golden at yahoo.com; ghc-devs at haskell.org
Sent: Friday, August 22, 2014 5:38 AM
Subject: RE: Suggestion for GHC System User's Guide documentation change
Marginally less verbose; why not use the language extension *only* in running text? Preferably with a link to the documentation of that language extension. In your example:
| The language extension <ref>UnicodeSyntax</ref> enables Unicode characters to be
| used to stand for certain ASCII character sequences.
With regards to code examples: Ideally any explicit code example could just be copy-pasted into a .hs-file and loaded into ghci / compiled with ghc without special switches.
Just my two cents ;)
Ph.
More information about the ghc-devs
mailing list