Skip to content

Commit 9f79b95

Browse files
committed
Use markdown links in documentation
1 parent 540e097 commit 9f79b95

File tree

2 files changed

+18
-27
lines changed

2 files changed

+18
-27
lines changed

docs/Node/FS/Sync.md

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -197,9 +197,8 @@ fdOpen :: forall eff. FilePath -> FileFlags -> Maybe FileMode -> Eff (err :: EXC
197197
fdRead :: forall eff. FileDescriptor -> Buffer -> BufferOffset -> BufferLength -> Maybe FilePosition -> Eff (buffer :: BUFFER, err :: EXCEPTION, fs :: FS | eff) ByteCount
198198
```
199199

200-
Read to a file synchronously. See <a
201-
href="http://nodejs.org/api/fs.html#fs_fs_readsync_fd_buffer_offset_length_position">Node
202-
ocumentation</a> for details.
200+
Read from a file synchronously. See the [Node documentation](http://nodejs.org/api/fs.html#fs_fs_readsync_fd_buffer_offset_length_position)
201+
for details.
203202

204203
#### `fdNext`
205204

@@ -216,9 +215,8 @@ file position.
216215
fdWrite :: forall eff. FileDescriptor -> Buffer -> BufferOffset -> BufferLength -> Maybe FilePosition -> Eff (buffer :: BUFFER, err :: EXCEPTION, fs :: FS | eff) ByteCount
217216
```
218217

219-
Write to a file synchronously. See <a
220-
href="http://nodejs.org/api/fs.html#fs_fs_writesync_fd_buffer_offset_length_position">Node
221-
Documentation</a> for details.
218+
Write to a file synchronously. See the [Node documentation](http://nodejs.org/api/fs.html#fs_fs_writesync_fd_buffer_offset_length_position)
219+
for details.
222220

223221
#### `fdAppend`
224222

@@ -235,18 +233,16 @@ file position.
235233
fdFlush :: forall eff. FileDescriptor -> Eff (err :: EXCEPTION, fs :: FS | eff) Unit
236234
```
237235

238-
Flush a file synchronously. See <a
239-
href="http://nodejs.org/api/fs.html#fs_fs_fsyncsync_fd">Node
240-
Documentation</a> for details.
236+
Flush a file synchronously. See the [Node documentation](http://nodejs.org/api/fs.html#fs_fs_fsyncsync_fd)
237+
for details.
241238

242239
#### `fdClose`
243240

244241
``` purescript
245242
fdClose :: forall eff. FileDescriptor -> Eff (err :: EXCEPTION, fs :: FS | eff) Unit
246243
```
247244

248-
Close a file synchronously. See <a
249-
href="http://nodejs.org/api/fs.html#fs_fs_closesync_fd">Node
250-
Documentation</a> for details.
245+
Close a file synchronously. See the [Node documentation](http://nodejs.org/api/fs.html#fs_fs_closesync_fd)
246+
for details.
251247

252248

src/Node/FS/Sync.purs

Lines changed: 10 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -260,9 +260,8 @@ exists file = return $ fs.existsSync file
260260

261261
{- Synchronous File Descriptor Functions -}
262262

263-
-- | Open a file synchronously. See <a
264-
-- | href="http://nodejs.org/api/fs.html#fs_fs_opensync_path_flags_mode">Node
265-
-- | Documentation</a> for details.
263+
-- | Open a file synchronously. See the [Node documentation](http://nodejs.org/api/fs.html#fs_fs_opensync_path_flags_mode)
264+
-- | for details.
266265
fdOpen :: forall eff.
267266
FilePath
268267
-> FileFlags
@@ -271,9 +270,8 @@ fdOpen :: forall eff.
271270
fdOpen file flags mode = mkEff $ \_ ->
272271
runFn3 fs.openSync file (fileFlagsToNode flags) (toNullable mode)
273272

274-
-- | Read to a file synchronously. See <a
275-
-- | href="http://nodejs.org/api/fs.html#fs_fs_readsync_fd_buffer_offset_length_position">Node
276-
-- | ocumentation</a> for details.
273+
-- | Read from a file synchronously. See the [Node documentation](http://nodejs.org/api/fs.html#fs_fs_readsync_fd_buffer_offset_length_position)
274+
-- | for details.
277275
fdRead :: forall eff.
278276
FileDescriptor
279277
-> Buffer
@@ -294,9 +292,8 @@ fdNext fd buff = do
294292
sz <- size buff
295293
fdRead fd buff 0 sz Nothing
296294

297-
-- | Write to a file synchronously. See <a
298-
-- | href="http://nodejs.org/api/fs.html#fs_fs_writesync_fd_buffer_offset_length_position">Node
299-
-- | Documentation</a> for details.
295+
-- | Write to a file synchronously. See the [Node documentation](http://nodejs.org/api/fs.html#fs_fs_writesync_fd_buffer_offset_length_position)
296+
-- | for details.
300297
fdWrite :: forall eff.
301298
FileDescriptor
302299
-> Buffer
@@ -317,17 +314,15 @@ fdAppend fd buff = do
317314
sz <- size buff
318315
fdWrite fd buff 0 sz Nothing
319316

320-
-- | Flush a file synchronously. See <a
321-
-- | href="http://nodejs.org/api/fs.html#fs_fs_fsyncsync_fd">Node
322-
-- | Documentation</a> for details.
317+
-- | Flush a file synchronously. See the [Node documentation](http://nodejs.org/api/fs.html#fs_fs_fsyncsync_fd)
318+
-- | for details.
323319
fdFlush :: forall eff.
324320
FileDescriptor
325321
-> Eff (err :: EXCEPTION, fs :: FS | eff) Unit
326322
fdFlush fd = mkEff $ \_ -> runFn1 fs.fsyncSync fd
327323

328-
-- | Close a file synchronously. See <a
329-
-- | href="http://nodejs.org/api/fs.html#fs_fs_closesync_fd">Node
330-
-- | Documentation</a> for details.
324+
-- | Close a file synchronously. See the [Node documentation](http://nodejs.org/api/fs.html#fs_fs_closesync_fd)
325+
-- | for details.
331326
fdClose :: forall eff.
332327
FileDescriptor
333328
-> Eff (err :: EXCEPTION, fs :: FS | eff) Unit

0 commit comments

Comments
 (0)