suzanne.soy/racket
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Clarify docs for `collection-path' to discourage its use.

Browse Source
This commit is contained in:
Vincent St-Amour 2013-11-04 15:35:16 -05:00
parent 54e3380375
commit 1cd823a59a
1 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
pkgs/racket-pkgs/racket-doc/scribblings/reference/collects.scrbl
View File

@ -283,11 +283,14 @@ and the collection is not found, then the
[#:fail fail-proc (string? . -> . any)]) [#:fail fail-proc (string? . -> . any)])
any])]{ any])]{
This function is @bold{legacy}. Its use should be avoided.
The @racket[collection-file-path] function should be used instead.
Like @racket[collection-file-path], but without a specified file name, Like @racket[collection-file-path], but without a specified file name,
so that the first directory indicated by @racket[collection]s is so that the first directory indicated by @racket[collection]s is
returned. The @racket[collection-file-path] function normally should returned. If multiple packages provide @racket[collection], the path
be used, instead, to support splicing of library-collection trees at corresponding to the first package (in collection resolution order) is
the file level.} returned.}
@defparam*[current-library-collection-paths paths @defparam*[current-library-collection-paths paths