Documentation update for fs-api

input-output-hk · Jul 17, 2024 · 5a79bb8 · 5a79bb8
1 parent ac14fee
commit 5a79bb8
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/fs-api/README.md b/fs-api/README.md
@@ -16,10 +16,10 @@ data HasFS m h = HasFS {
 
 Code that is written using this interface can be run against any implementation
 of a file system. The `System.FS.IO` module provides a function for initialising
-a `HasFS` interface for the built-in filesystem.
+a `HasFS` interface for the real filesystem.
 
 ```haskell
-ioHasFS :: MonadIO m => MountPoint -> HasFS m HandleIO
+ioHasFS :: (MonadIO m, PrimState IO ~ PrimState m) => MountPoint -> HasFS m HandleIO
 ```
 
 Note that `ioHasFS` requires some context in the form of a `MountPoint`: the

diff --git a/fs-api/fs-api.cabal b/fs-api/fs-api.cabal
@@ -1,8 +1,8 @@
 cabal-version:   3.0
 name:            fs-api
 version:         0.2.0.1
-synopsis:        API for file systems
-description:     API for file systems.
+synopsis:        Abstract interface for the file system
+description:     Abstract interface for the file system.
 license:         Apache-2.0
 license-files:
   LICENSE