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

Clarify use of build-path/convention-type in scribble docs (fixes #3424)

Browse Source 
I constructed this PR using GitHub's edit feature, so the commit has not been tested.
This commit is contained in:
Joel Dueck 2020-12-08 17:19:00 -06:00 committed by Matthew Flatt
parent 9b6f02238b
commit 3260489fd3
1 changed files with 14 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
pkgs/racket-doc/scribblings/reference/paths.scrbl
View File

@ -302,7 +302,20 @@ Windows examples.
path-for-some-system?]{
Like @racket[build-path], except a path convention type is specified
explicitly.}
explicitly.
Note that, just as with @racket[build-path], any string arguments for either
@racket[base] or @racket[sub] will be implicitly converted into a path for the
current platform before being combined with the others. For this reason, you
cannot use this function to build paths from strings for any platform other
than the current one; in such attempts, @racket[type] does not match the
inferred convention type for the strings and an @exnraise[exn:fail:contract].
(To create paths for foreign platforms, see @racket[bytes->path].)
The usefulness of @racket[build-path/convention-type] over @racket[build-path]
is limited to cases where the sub-paths contain @racket['same] or @racket['up]
elements.}
@defproc[(absolute-path? [path (or/c path? string? path-for-some-system?)]) boolean?]{