Skip to content

Commit cb72dc3

Browse files
committed
Fix small documentation inconsistencies
1 parent def6d63 commit cb72dc3

File tree

3 files changed

+20
-33
lines changed

3 files changed

+20
-33
lines changed

docs/User/Tutorials/module-structure-and-quick-examples.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ In general, using scans, we can split the stream into multiple streams
127127
and perform different stateful computations in each branch and then
128128
merge them back into a single stream.
129129

130-
See "Streamly.Data.Scan" module.
130+
See "Streamly.Data.Scanl" module.
131131

132132
### Parser Type
133133

docs/User/Tutorials/replacing-other-packages.md

Lines changed: 12 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -35,12 +35,12 @@ The streamly modules `Streamly.Data.Stream`, `Streamly.Data.Fold` cover
3535
the entire `Data.List` functionality as well as split and string search
3636
functionality. String interpolation is provided by `Streamly.Unicode.String`.
3737

38-
| Package | Streamly Type | Combinators |
39-
|----------------|---------------|------------------------------|
40-
| base/Data.List | Stream | |
41-
| interpolate | | str |
42-
| split | Stream, Fold | splitOn, takeEndBy etc |
43-
| stringsearch | Stream, Fold | splitOnSeq, takeEndBySeq etc |
38+
| Package | Streamly Type | Combinators |
39+
|----------------|---------------|----------------------------------|
40+
| base/Data.List | Stream | |
41+
| interpolate | | str |
42+
| split | Stream, Fold | splitSepBy_, takeEndBy etc |
43+
| stringsearch | Stream, Fold | splitSepBySeq_, takeEndBySeq etc |
4444

4545
Note that `Data.List` can be easy to use and just enough in many use
4646
cases. However, it can be limiting in other cases e.g. if you have to
@@ -57,16 +57,16 @@ the Rust ripgrep performance.
5757

5858
## Streaming
5959

60-
The streamly modules `Streamly.Data.Stream`, `Streamly.Data.Scan` and
60+
The streamly modules `Streamly.Data.Stream`, `Streamly.Data.Scanl` and
6161
`Streamly.Data.Fold` cover the streaming functionality with superior
6262
performance compared to any other packages.
6363

6464
| Package | Streamly Type |
6565
|----------------|-----------------------------------|
66-
| streaming | Stream, Scan, Fold |
67-
| pipes | Stream, Scan, Fold |
68-
| conduit | Stream, Scan, Fold |
69-
| foldl | Scan, Fold |
66+
| streaming | Stream, Scanl, Fold |
67+
| pipes | Stream, Scanl, Fold |
68+
| conduit | Stream, Scanl, Fold |
69+
| foldl | Scanl, Fold |
7070

7171
## List Transformer and Logic Programming
7272

@@ -225,23 +225,14 @@ The relevant modules in streamly are:
225225
* `Streamly.FileSystem.DirIO`
226226
* `Streamly.FileSystem.FileIO`
227227
* `Streamly.FileSystem.Handle`
228-
* `Streamly.Internal.FileSystem.Event`
229-
* `Streamly.Internal.FileSystem.Event.Linux`
230-
* `Streamly.Internal.FileSystem.Event.Darwin`
231-
* `Streamly.Internal.FileSystem.Event.Windows`
232228

233229
| Package | Streamly Module |
234230
|-----------------------|--------------------------------------------|
235231
| base/System.IO | Streamly.FileSystem.FileIO,Handle |
236232
| filepath | Streamly.FileSystem.Path |
237-
| path | Streamly.Internal.FileSystem.Path.LocSeg |
238-
| path | Streamly.Internal.FileSystem.Path.FileDir |
233+
| path | Streamly.Internal.FileSystem.Path.SegNode |
239234
| path | Streamly.Internal.FileSystem.Path.Typed |
240235
| directory | Streamly.FileSystem.DirIO |
241-
| fsnotify | Streamly.Internal.FileSystem.Event |
242-
| fsnotify | Streamly.Internal.FileSystem.Event.Windows |
243-
| hinotify | Streamly.Internal.FileSystem.Event.Linux |
244-
| hfsevents | Streamly.Internal.FileSystem.Event.Darwin |
245236

246237
## Network
247238

docs/User/Tutorials/types-and-modules.md

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ The following table lists the modules and types for monadic stream producers
1010
| Streamly.Data.Stream | Stream m a | Streams using stream fusion, for static composition |
1111
| Streamly.Data.Unfold | Unfold m a b | Streams using nested stream fusion, for static composition |
1212
| Streamly.Data.StreamK | StreamK m a | Streams using CPS, for dynamic composition |
13-
| Streamly.Data.Scan | Scan m a b | Scans using stream fusion, for static composition |
13+
| Streamly.Data.Scanl | Scanl m a b | Scans using stream fusion, for static composition |
1414
| Streamly.Data.Fold | Fold m a b | Folds using stream fusion, for static composition |
1515
| Streamly.Data.Parser | Parser a m b | Parsers using stream fusion, for static composition |
1616
| Streamly.Data.ParserK | ParserK a m b | Parsers using CPS, for dynamic composition |
@@ -62,16 +62,12 @@ File system path representation:
6262

6363
Console and file system operations:
6464

65-
| Module | Description |
66-
|--------------------------------------------|--------------------------------------------------|
67-
| Streamly.Console.Stdio | Console standard input, output, error operations |
68-
| Streamly.FileSystem.Handle | Handle based read/write operations |
69-
| Streamly.FileSystem.FileIO | File path based read, write operations |
70-
| Streamly.FileSystem.DirIO | Directory read operations |
71-
| Streamly.Internal.FileSystem.Event | File system event notification streams |
72-
| Streamly.Internal.FileSystem.Event.Windows | Event notification streams for Windows |
73-
| Streamly.Internal.FileSystem.Event.Linux | Event notification streams for Linux |
74-
| Streamly.Internal.FileSystem.Event.Darwin | Event notification streams for macOS |
65+
| Module | Description |
66+
|----------------------------|--------------------------------------------------|
67+
| Streamly.Console.Stdio | Console standard input, output, error operations |
68+
| Streamly.FileSystem.Handle | Handle based read/write operations |
69+
| Streamly.FileSystem.FileIO | File path based read, write operations |
70+
| Streamly.FileSystem.DirIO | Directory read operations |
7571

7672
## Network Operations
7773

0 commit comments

Comments
 (0)