Skip to content
This repository was archived by the owner on Mar 17, 2021. It is now read-only.

Commit 7a123da

Browse files
committed
Improve normalize docs
1 parent 4cfa035 commit 7a123da

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

src/Foreign/Lua/Module/Path.hs

+6-4
Original file line numberDiff line numberDiff line change
@@ -216,10 +216,12 @@ normalize = toHsFnPrecursor Path.normalise
216216
#? T.unlines
217217
[ "Normalizes a path."
218218
, ""
219-
, "- `//` outside of the drive can be made blank"
220-
, "- `/` becomes the `path.separator`"
221-
, "- `./` -> \'\'"
222-
, "- an empty path becomes `.`"
219+
, " - `//` makes sense only as part of a (Windows) network drive;"
220+
, " elsewhere, multiple slashes are reduced to a single"
221+
, " `path.separator` (platform dependent)."
222+
, " - `/` becomes `path.separator` (platform dependent)."
223+
, " - `./` is removed."
224+
, " - an empty path becomes `.`"
223225
]
224226

225227
-- | See @Path.splitDirectories@.

0 commit comments

Comments
 (0)