[Hackage] #724: Functions in Paths_pkgname module need documenting in the user guide (was: Add getDataDirectory function to Paths_pkgname)

Hackage cvs-ghc at haskell.org
Sat Aug 21 09:55:57 EDT 2010


#724: Functions in Paths_pkgname module need documenting in the user guide
----------------------------------+-----------------------------------------
  Reporter:  tommd                |        Owner:         
      Type:  enhancement          |       Status:  new    
  Priority:  normal               |    Milestone:         
 Component:  Cabal library        |      Version:  1.6.0.3
  Severity:  normal               |     Keywords:         
Difficulty:  very easy (<1 hour)  |   Ghcversion:         
  Platform:                       |  
----------------------------------+-----------------------------------------
Changes (by duncan):

  * difficulty:  unknown => very easy (<1 hour)


Comment:

 There already is a `getDataDir` function.

 The module exports the following functions:
 {{{
 getBinDir
 getLibDir
 getDataDir
 getLibexecDir
 getDataFileName
 }}}

 What is missing however is documentation of the above in the user guide.
 Currently it only documents the last one:
 http://haskell.org/cabal/release/cabal-latest/doc/users-guide/authors.html
 #paths-module

 Updating the ticket name to reflect the issue.

-- 
Ticket URL: <http://hackage.haskell.org/trac/hackage/ticket/724#comment:1>
Hackage <http://haskell.org/cabal/>
Hackage: Cabal and related projects



More information about the cabal-devel mailing list