doc tweak for Directory file type: file names are '\0'-separated

[ghc-base.git] / GHC / IO / Device.hs

diff --git a/GHC/IO/Device.hs b/GHC/IO/Device.hs
index d1a6712..8f907d5 100644 (file)
--- a/GHC/IO/Device.hs
+++ b/GHC/IO/Device.hs
@@ -144,14 +144,13 @@ ioe_unsupportedOperation = throwIO unsupportedOperation
 
 data IODeviceType
   = Directory -- ^ The standard libraries do not have direct support
-              -- for this device type, but user implementation is
-              -- expected to provide a newline-separated list of
-              -- file names in a directory (without path to the
-              -- directory itself) in any order,
-              -- excluding the @"."@ and @".."@ names. See
-              -- also 'System.Directory.getDirectoryContents'.
-              -- Seek operations are not supported on directories
-              -- (other than to the zero position).
+              -- for this device type, but a user implementation is
+              -- expected to provide a list of file names in
+              -- the directory, in any order, separated by @'\0'@
+              -- characters, excluding the @"."@ and @".."@ names. See
+              -- also 'System.Directory.getDirectoryContents'.  Seek
+              -- operations are not supported on directories (other
+              -- than to the zero position).
   | Stream    -- ^ A duplex communications channel (results in
               -- creation of a duplex 'GHC.IO.Handle.Handle'). The
               -- standard libraries use this device type when