pkg/pnr-db: fir and document `get-module-pkgs'

This commit is contained in:
Matthew Flatt 2013-04-22 09:35:29 -06:00
parent 1fa80c84e0
commit ef0491be07
2 changed files with 13 additions and 3 deletions

View File

@ -39,7 +39,7 @@
[set-pkg-tags! (string? string? (listof string?)
. -> . void?)]
[get-module-pkgs (module-path? . -> . pkg?)]
[get-module-pkgs (module-path? . -> . (listof pkg?))]
[get-pkgs-without-modules (()
(#:index string?)

View File

@ -1,7 +1,8 @@
#lang scribble/manual
@(require (for-label racket/base
racket/contract/base
pkg/pnr-db))
pkg/pnr-db
syntax/modcollapse))
@title[#:tag "pnr-db"]{Package Name Database}
@ -128,7 +129,16 @@ Gets or sets a list of tags for the package
Gets or sets a list of module paths that are provided for the package
@racket[name] as recognized by the @tech{package name resolver}
@racket[index] and for a specific @tech{checksum}.}
@racket[index] and for a specific @tech{checksum}. The module paths
should be normalized in the sense of @racket[collapse-module-path].}
@defproc[(get-module-pkgs [module-path module-path?])
(listof pkg?)]{
Reports a list of packages that implement the given
@racket[module-path], which should be normalized in the sense of
@racket[collapse-module-path].}
@defproc[(get-pkgs-without-modules [#:index index (or/c #f string?) #f])