Skip to content
This repository was archived by the owner on Mar 22, 2021. It is now read-only.

Commit 8940449

Browse files
committed
README: state function return types more precisely
1 parent e5b5923 commit 8940449

1 file changed

Lines changed: 14 additions & 11 deletions

File tree

README.md

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -282,7 +282,7 @@ Parameters:
282282

283283
Returns:
284284

285-
- The modified filepath without extension.
285+
- The modified filepath without extension (string).
286286

287287
This function wraps [System.FilePath.dropExtension].
288288

@@ -304,7 +304,8 @@ Parameters:
304304

305305
Returns:
306306

307-
- `true` if `filepath` has an extension.
307+
- `true` iff `filepath` has an extension, `false` otherwise
308+
(boolean).
308309

309310
This function wraps [System.FilePath.hasExtension].
310311

@@ -321,7 +322,8 @@ Parameters:
321322

322323
Returns:
323324

324-
- `true` if `filepath` is an absolute path.
325+
- `true` iff `filepath` is an absolute path, `false` otherwise
326+
(boolean).
325327

326328
This function wraps [System.FilePath.isAbsolute].
327329

@@ -340,11 +342,12 @@ isRelative("/") == false
340342
Parameters:
341343

342344
`filepath`
343-
: path
345+
: path (string)
344346

345347
Returns:
346348

347-
- `true` if `filepath` is a relative path.
349+
- `true` iff `filepath` is a relative path, `false` otherwise
350+
(boolean).
348351

349352
This function wraps [System.FilePath.isRelative].
350353

@@ -365,7 +368,7 @@ Parameters:
365368

366369
Returns:
367370

368-
- The joined path.
371+
- The joined path (string).
369372

370373
This function wraps [System.FilePath.joinPath].
371374

@@ -382,7 +385,7 @@ Parameters:
382385

383386
Returns:
384387

385-
- The normalised path.
388+
- The normalised path (string).
386389

387390
This function wraps [System.FilePath.normalise].
388391

@@ -405,7 +408,7 @@ Parameters:
405408

406409
Returns:
407410

408-
- A list of all directory paths.
411+
- A list of all directory paths (list of strings).
409412

410413
This function wraps [System.FilePath.splitDirectories].
411414

@@ -427,7 +430,7 @@ Parameters:
427430

428431
Returns:
429432

430-
- The modified filepath.
433+
- The filepath up to the last directory separator (string).
431434

432435
This function wraps [System.FilePath.takeDirectory].
433436

@@ -449,7 +452,7 @@ Parameters:
449452

450453
Returns:
451454

452-
- String of all extensions.
455+
- String of all extensions (string).
453456

454457
This function wraps [System.FilePath.takeExtensions].
455458

@@ -471,7 +474,7 @@ Parameters:
471474

472475
Returns:
473476

474-
- The file name.
477+
- The file name (string).
475478

476479
This function wraps [System.FilePath.takeFileName].
477480

0 commit comments

Comments
 (0)