Skip to content

Commit 06a9edc

Browse files
committed
Improve 'fromString' haddocks
1 parent 0228e24 commit 06a9edc

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

System/OsString/Common.hs

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -296,12 +296,14 @@ encodeLE = fmap PosixString . encodeWithBasePosix'
296296
#endif
297297

298298
#ifdef WINDOWS
299-
-- | Like 'encodeFS', but not in IO.
299+
-- | Like 'encodeLE but not in IO.
300300
--
301-
-- 'encodeFS' was designed to have a symmetric type signature
301+
-- 'encodeLE' was designed to have a symmetric type signature
302302
-- on unix and windows, but morally the function has no IO effects on windows,
303303
-- so we provide this variant without breaking existing API.
304304
--
305+
-- On windows, 'encodeLE' is equivalent to 'encodeFS'.
306+
--
305307
-- This function does not exist on unix.
306308
--
307309
-- @since 2.0.6

0 commit comments

Comments
 (0)