[GHC] #1903: Meta-Proposal: Documentation should be required to say when exports were introduced

GHC trac at galois.com
Sat Nov 17 09:12:05 EST 2007


#1903: Meta-Proposal: Documentation should be required to say when exports were
introduced
-------------------------+--------------------------------------------------
    Reporter:  igloo     |       Owner:         
        Type:  proposal  |      Status:  new    
    Priority:  normal    |   Milestone:  Not GHC
   Component:  Compiler  |     Version:  6.8.1  
    Severity:  normal    |    Keywords:         
  Difficulty:  Unknown   |    Testcase:         
Architecture:  Unknown   |          Os:  Unknown
-------------------------+--------------------------------------------------
 One of the nice things about, for example, PHP is that if you look at the
 documentation for one of its functions, e.g.:
 http://www.php.net/manual/en/function.file-get-contents.php,
 it tells you that `file_get_contents` is available in PHP >= 4.3.0.

 I propose that all exports in Haskell libraries should be required to have
 such a thing in their haddock documentation. For the current code we could
 either give the current versions as the date of introduction, or do some
 digging and put precise data in.

 Initial deadline: 1 December 2007.

-- 
Ticket URL: <http://hackage.haskell.org/trac/ghc/ticket/1903>
GHC <http://www.haskell.org/ghc/>
The Glasgow Haskell Compiler


More information about the Glasgow-haskell-bugs mailing list