Functions in Paths_pkgname module need documenting in the user guide #715

Closed
bos opened this Issue May 24, 2012 · 1 comment

Comments

Projects
None yet
2 participants
Contributor

bos commented May 24, 2012

(Imported from Trac #724, reported by @TomMD on 2010-08-13)

Some libraries and programs have a large number of files. Instead of having explicit knowledge of each file (and instead of using a mutation on the result of getDataFilename) there should be a "getDataDirectory" or a "getDataDirectoryContents":

getDataDirectoryContents = getDataDirectory >>= getDirectoryContents
Contributor

bos commented May 24, 2012

(Imported comment by @dcoutts on 2010-08-13)

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.

@ttuegel ttuegel added bug easy and removed enhancement labels Apr 23, 2015

ttuegel added this to the cabal-install-1.24 milestone Apr 23, 2015

ezyang closed this in b0c146a May 1, 2015

@23Skidoo 23Skidoo added a commit that referenced this issue May 1, 2015

@23Skidoo 23Skidoo Merge pull request #2570 from ezyang/cabal-715
Document more functions in Paths_pkgname, fixes #715
1201bc7
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment