Improve 'fromString' haddocks

haskell · Jun 29, 2024 · 06a9edc · 06a9edc
1 parent 0228e24
commit 06a9edc
Showing 1 changed file with 4 additions and 2 deletions.
diff --git a/System/OsString/Common.hs b/System/OsString/Common.hs
@@ -296,12 +296,14 @@ encodeLE = fmap PosixString . encodeWithBasePosix'
 #endif
 
 #ifdef WINDOWS
--- | Like 'encodeFS', but not in IO.
+-- | Like 'encodeLE but not in IO.
 --
--- 'encodeFS' was designed to have a symmetric type signature
+-- 'encodeLE' was designed to have a symmetric type signature
 -- on unix and windows, but morally the function has no IO effects on windows,
 -- so we provide this variant without breaking existing API.
 --
+-- On windows, 'encodeLE' is equivalent to 'encodeFS'.
+--
 -- This function does not exist on unix.
 --
 -- @since 2.0.6