git.iko.soy/streamly
on master help sign in
Fix docs for filesystem modules
0c25ce6Harendra Kumar
core/src/Streamly/FileSystem/Dir.hs+4
compare with master
unifiedsplit
@@ -6,6 +6,10 @@
6-- Maintainer : streamly@composewell.com
6-- Maintainer : streamly@composewell.com
7-- Stability : pre-release
7-- Stability : pre-release
8-- Portability : GHC
8-- Portability : GHC
9+--
10+-- Warning\: The API of this module is subject to change in future releases.
11+-- Especially the type for representing paths may change from 'FilePath' to
12+-- something else.
9
13
10module Streamly.FileSystem.Dir
14module Streamly.FileSystem.Dir
11 (
15 (
core/src/Streamly/FileSystem/File.hs+6−2
@@ -7,15 +7,19 @@
7-- Stability : pre-release
7-- Stability : pre-release
8-- Portability : GHC
8-- Portability : GHC
9--
9--
10+-- Warning\: The API of this module is subject to change in future releases.
11+-- Especially the type for representing paths may change from 'FilePath' to
12+-- something else.
13+--
10-- Read and write streams and arrays to and from files specified by their paths
14-- Read and write streams and arrays to and from files specified by their paths
11-- in the file system. Unlike the handle based APIs which can have a read/write
15-- in the file system. Unlike the handle based APIs which can have a read/write
12-- session consisting of multiple reads and writes to the handle, these APIs
16-- session consisting of multiple reads and writes to the handle, these APIs
13-- are one shot read or write APIs. These APIs open the file handle, perform
17-- are one shot read or write APIs. These APIs open the file handle, perform
14−-- the requested operation and close the handle. Thease are safer compared to
18+-- the requested operation and close the handle. These are safer compared to
15-- the handle based APIs as there is no possibility of a file descriptor
19-- the handle based APIs as there is no possibility of a file descriptor
16-- leakage.
20-- leakage.
17--
21--
18−-- > import qualified Streamly.FileSystem.File as File
22+-- >>> import qualified Streamly.FileSystem.File as File
19--
23--
20module Streamly.FileSystem.File
24module Streamly.FileSystem.File
21 (
25 (
core/src/Streamly/FileSystem/Handle.hs+2−2
@@ -15,8 +15,8 @@
15-- ('Handle').
15-- ('Handle').
16--
16--
17-- The 'TextEncoding', 'NewLineMode', and 'Buffering' options of the underlying
17-- The 'TextEncoding', 'NewLineMode', and 'Buffering' options of the underlying
18−-- GHC 'Handle' are ignored by these APIs. Please use @Streamly.Unicode.*@
18+-- GHC 'Handle' are ignored by these APIs. Please use "Streamly.Unicode.Stream"
19−-- modules for encoding and decoding a byte stream, use stream splitting
19+-- module for encoding and decoding a byte stream, use stream splitting
20-- operations in "Streamly.Data.Stream" to create a stream of lines or to split
20-- operations in "Streamly.Data.Stream" to create a stream of lines or to split
21-- the input stream on any other type of boundaries.
21-- the input stream on any other type of boundaries.
22--
22--