Skip to content

Commit 8a4ca42

Browse files
committed
Fix docs
These comments were preventing the fdOpen documentation from being shown in Node.FS.{Async,Sync}. This should eventually be addressed in the compiler, but this will do for now.
1 parent 9f79b95 commit 8a4ca42

File tree

4 files changed

+6
-5
lines changed

4 files changed

+6
-5
lines changed

docs/Node/FS/Async.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -199,6 +199,9 @@ Check if the path exists.
199199
fdOpen :: forall eff. FilePath -> FileFlags -> Maybe FileMode -> Callback eff FileDescriptor -> Eff (fs :: FS | eff) Unit
200200
```
201201

202+
Open a file asynchronously. See the [Node Documentation](https://nodejs.org/api/fs.html#fs_fs_open_path_flags_mode_callback)
203+
for details.
204+
202205
#### `fdRead`
203206

204207
``` purescript

docs/Node/FS/Sync.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -191,6 +191,9 @@ Check if the path exists.
191191
fdOpen :: forall eff. FilePath -> FileFlags -> Maybe FileMode -> Eff (err :: EXCEPTION, fs :: FS | eff) FileDescriptor
192192
```
193193

194+
Open a file synchronously. See the [Node documentation](http://nodejs.org/api/fs.html#fs_fs_opensync_path_flags_mode)
195+
for details.
196+
194197
#### `fdRead`
195198

196199
``` purescript

src/Node/FS/Async.purs

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -297,9 +297,6 @@ exists :: forall eff. FilePath
297297
exists file cb = mkEff $ \_ -> runFn2
298298
fs.exists file $ \b -> runPure (unsafeInterleaveEff (cb b))
299299

300-
301-
{- Asynchronous File Descriptor Functions -}
302-
303300
-- | Open a file asynchronously. See the [Node Documentation](https://nodejs.org/api/fs.html#fs_fs_open_path_flags_mode_callback)
304301
-- | for details.
305302
fdOpen :: forall eff.

src/Node/FS/Sync.purs

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -258,8 +258,6 @@ exists :: forall eff. FilePath
258258
-> Eff (fs :: FS | eff) Boolean
259259
exists file = return $ fs.existsSync file
260260

261-
{- Synchronous File Descriptor Functions -}
262-
263261
-- | Open a file synchronously. See the [Node documentation](http://nodejs.org/api/fs.html#fs_fs_opensync_path_flags_mode)
264262
-- | for details.
265263
fdOpen :: forall eff.

0 commit comments

Comments
 (0)