From 1cd823a59a85757c45aca1ba4a19b823f38aea8b Mon Sep 17 00:00:00 2001 From: Vincent St-Amour Date: Mon, 4 Nov 2013 15:35:16 -0500 Subject: [PATCH] Clarify docs for `collection-path' to discourage its use. --- .../racket-doc/scribblings/reference/collects.scrbl | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/pkgs/racket-pkgs/racket-doc/scribblings/reference/collects.scrbl b/pkgs/racket-pkgs/racket-doc/scribblings/reference/collects.scrbl index 6682380496..b64cc0a3aa 100644 --- a/pkgs/racket-pkgs/racket-doc/scribblings/reference/collects.scrbl +++ b/pkgs/racket-pkgs/racket-doc/scribblings/reference/collects.scrbl @@ -283,11 +283,14 @@ and the collection is not found, then the [#:fail fail-proc (string? . -> . 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, so that the first directory indicated by @racket[collection]s is -returned. The @racket[collection-file-path] function normally should -be used, instead, to support splicing of library-collection trees at -the file level.} +returned. If multiple packages provide @racket[collection], the path +corresponding to the first package (in collection resolution order) is +returned.} @defparam*[current-library-collection-paths paths