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

clarify `path-element->string' docs

Browse Source
This commit is contained in:
Matthew Flatt 2011-03-11 15:51:33 -06:00
parent 02f6ef0ec0
commit 1a6dacc4c5
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
collects/scribblings/reference/paths.scrbl
View File

@ -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,