git.iko.soy/streamly
on master help sign in
Fix docs for filesystem modules

Add unstable API warning in the Dir module

commit0c25ce664736e45e144169b8111c5b42884be83b authorHarendra Kumar <harendra@composewell.com> dateTue 3 Jan 2023, 11:49 (4 years ago) parent35c4630
3 files changed+12−4
compare with master
unifiedsplit
core/src/Streamly/FileSystem/Dir.hs+4 core/src/Streamly/FileSystem/File.hs+6−2 core/src/Streamly/FileSystem/Handle.hs+2−2
core/src/Streamly/FileSystem/Dir.hs+4
@@ -6,6 +6,10 @@
66-- Maintainer : streamly@composewell.com
77-- Stability : pre-release
88-- 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.
913
1014module Streamly.FileSystem.Dir
1115 (
core/src/Streamly/FileSystem/File.hs+6−2
@@ -7,15 +7,19 @@
77-- Stability : pre-release
88-- Portability : GHC
99--
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+--
1014-- Read and write streams and arrays to and from files specified by their paths
1115-- in the file system. Unlike the handle based APIs which can have a read/write
1216-- session consisting of multiple reads and writes to the handle, these APIs
1317-- 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
1519-- the handle based APIs as there is no possibility of a file descriptor
1620-- leakage.
1721--
18−-- > import qualified Streamly.FileSystem.File as File
22+-- >>> import qualified Streamly.FileSystem.File as File
1923--
2024module Streamly.FileSystem.File
2125 (
core/src/Streamly/FileSystem/Handle.hs+2−2
@@ -15,8 +15,8 @@
1515-- ('Handle').
1616--
1717-- The 'TextEncoding', 'NewLineMode', and 'Buffering' options of the underlying
18−-- GHC 'Handle' are ignored by these APIs. Please use @Streamly.Unicode.*@
19−-- modules for encoding and decoding a byte stream, use stream splitting
18+-- GHC 'Handle' are ignored by these APIs. Please use "Streamly.Unicode.Stream"
19+-- module for encoding and decoding a byte stream, use stream splitting
2020-- operations in "Streamly.Data.Stream" to create a stream of lines or to split
2121-- the input stream on any other type of boundaries.
2222--