Skip to content

Commit 0400155

Browse files
committed
Documentation update for fs-api
1 parent 106d279 commit 0400155

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

fs-api/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,10 @@ data HasFS m h = HasFS {
1616

1717
Code that is written using this interface can be run against any implementation
1818
of a file system. The `System.FS.IO` module provides a function for initialising
19-
a `HasFS` interface for the built-in filesystem.
19+
a `HasFS` interface for the real filesystem.
2020

2121
```haskell
22-
ioHasFS :: MonadIO m => MountPoint -> HasFS m HandleIO
22+
ioHasFS :: (MonadIO m, PrimState IO ~ PrimState m) => MountPoint -> HasFS m HandleIO
2323
```
2424

2525
Note that `ioHasFS` requires some context in the form of a `MountPoint`: the

fs-api/fs-api.cabal

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
cabal-version: 3.0
22
name: fs-api
33
version: 0.2.0.1
4-
synopsis: API for file systems
5-
description: API for file systems.
4+
synopsis: Abstract interface for the file system
5+
description: Abstract interface for the file system.
66
license: Apache-2.0
77
license-files:
88
LICENSE

0 commit comments

Comments
 (0)