From 1a6dacc4c5818d2ea10c2a83d96a0c47466f5620 Mon Sep 17 00:00:00 2001 From: Matthew Flatt Date: Fri, 11 Mar 2011 15:51:33 -0600 Subject: [PATCH] clarify `path-element->string' docs --- collects/scribblings/reference/paths.scrbl | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/collects/scribblings/reference/paths.scrbl b/collects/scribblings/reference/paths.scrbl index 15d7c7b612..2024b22762 100644 --- a/collects/scribblings/reference/paths.scrbl +++ b/collects/scribblings/reference/paths.scrbl @@ -151,14 +151,13 @@ other path is deconstructed with @racket[split-path] and @racket[path-element->bytes]) when ASCII-level manipulation of path elements is necessary.} + @defproc[(path-element->string [path path?]) string?]{ -Like @racket[path->string], except any encoding prefix is removed. See -@secref["unixpaths"] for more information on the conversion for -@|AllUnix| paths, and see @secref["windowspaths"] for more -information on the conversion for Windows paths. -In addition, trailing path separators are removed, as by -@racket[split-path]. +Like @racket[path->string], except that trailing path separators are +removed (as by @racket[split-path]). Under Windows, any +@litchar{\\?\REL} encoding prefix is also removed; see +@secref["windowspaths"] for more information on Windows paths. The @racket[path] argument must be such that @racket[split-path] applied to @racket[path] would return @racket['relative] as its first @@ -168,6 +167,7 @@ result and a path as its second result, otherwise the The @racket[path-element->string] procedure is generally the best choice for presenting a pathless file or directory name to a user.} + @defproc[(path-element->bytes [path path-string?]) bytes?]{ Like @racket[path->bytes], except that any encoding prefix is removed,