[GHC] #10900: Suggestions for improvement of the PatternSynonyms chapter in the User's Guide

[GHC]

#10900: Suggestions for improvement of the PatternSynonyms chapter in the User's
Guide
-------------------------------------+-------------------------------------
        Reporter:  thomie            |                Owner:  mpickering
            Type:  bug               |               Status:  closed
        Priority:  normal            |            Milestone:
       Component:  Documentation     |              Version:  7.10.2
      Resolution:  fixed             |             Keywords:
                                     |  PatternSynonms
Operating System:  Unknown/Multiple  |         Architecture:
 Type of failure:  Documentation     |  Unknown/Multiple
  bug                                |            Test Case:
      Blocked By:                    |             Blocking:
 Related Tickets:                    |  Differential Rev(s):
       Wiki Page:                    |
-------------------------------------+-------------------------------------

Comment (by nomeata):

 The user guide (which is definitely much improved) still reads

 > A more complete specification can be found on the ghc-wiki.

 I really think we should refrain from linking to the wiki from the users
 guide. For implemented stuff, the user’s guide should contain all that is
 necessary for a user to understand a feature. If there is anything of
 relevance in the wiki, then it needs to be moved to the user’s guide.

 OTOH, if there is nothing of relevance to the user (e.g. rationale for
 this particular design, implementation aspects, historical notes), then we
 should send him there. Or at least write something like “For information
 on the history, the design process and the implementation, see the ghc-
 wiki”.

 If you are worried about duplicated information, then ''remove'' from the
 wiki page whatever now has its authoritative place in the user’s guide,
 and maybe link to that from the wiki page.

--
Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/10900#comment:7>
GHC <http://www.haskell.org/ghc/>
The Glasgow Haskell Compiler