From 06a9edc5d25191f658407786d9d964e34d09755f Mon Sep 17 00:00:00 2001
From: Julian Ospald <hasufell@posteo.de>
Date: Sun, 30 Jun 2024 01:08:03 +0800
Subject: [PATCH] Improve 'fromString' haddocks

---
 System/OsString/Common.hs | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/System/OsString/Common.hs b/System/OsString/Common.hs
index 3bc7e66..9916acc 100644
--- 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