Skip to content

Commit 69dcdba

Browse files
committed
Minor docs fixes
1 parent 2479592 commit 69dcdba

File tree

9 files changed

+28
-28
lines changed

9 files changed

+28
-28
lines changed

packages/utilities/eff/docs/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,15 @@
66
| ------ | ------ |
77
| [NarrowedTo](type-aliases/NarrowedTo.md) | An extension of Extract for type predicates which falls back to the base in order to narrow the `unknown` case. |
88
| [Pretty](type-aliases/Pretty.md) | - |
9-
| [unit](type-aliases/unit.md) | alias for `undefined` |
9+
| [unit](type-aliases/unit.md) | alias for `undefined`. |
1010

1111
## Variables
1212

1313
| Variable | Description |
1414
| ------ | ------ |
1515
| [compose](variables/compose.md) | Composes two functions, `ab` and `bc` into a single function that takes in an argument `a` of type `A` and returns a result of type `C`. The result is obtained by first applying the `ab` function to `a` and then applying the `bc` function to the result of `ab`. |
1616
| [dual](variables/dual.md) | Creates a function that can be used in a data-last (aka `pipe`able) or data-first style. |
17-
| [unit](variables/unit.md) | alias for `undefined` |
17+
| [unit](variables/unit.md) | alias for `undefined`. |
1818

1919
## Functions
2020

@@ -23,10 +23,10 @@
2323
| [absurd](functions/absurd.md) | The `absurd` function is a stub for cases where a value of type `never` is encountered in your code, meaning that it should be impossible for this code to be executed. |
2424
| [apply](functions/apply.md) | Apply a function to a given value. |
2525
| [constant](functions/constant.md) | Returns a function that always returns the same value. |
26-
| [constFalse](functions/constFalse.md) | Do nothing and return false |
27-
| [constNull](functions/constNull.md) | Do nothing and return null |
28-
| [constTrue](functions/constTrue.md) | Do nothing and return true |
29-
| [constVoid](functions/constVoid.md) | Do nothing and return void |
26+
| [constFalse](functions/constFalse.md) | Do nothing and return `false`. |
27+
| [constNull](functions/constNull.md) | Do nothing and return `null`. |
28+
| [constTrue](functions/constTrue.md) | Do nothing and return `true`. |
29+
| [constVoid](functions/constVoid.md) | Do nothing and return `void`. |
3030
| [flip](functions/flip.md) | Reverses the order of arguments for a curried function. |
3131
| [flow](functions/flow.md) | Performs left-to-right function composition. The first argument may have any arity, the remaining arguments must be unary. |
3232
| [getOrElse](functions/getOrElse.md) | Retrieves a value from a Map or WeakMap if the key exists, or computes a new value if it doesn't. |
@@ -42,4 +42,4 @@
4242
| [pipeArguments](functions/pipeArguments.md) | - |
4343
| [tryAddToSet](functions/tryAddToSet.md) | Attempts to add a value to a Set, but only if it doesn't already exist. |
4444
| [tupled](functions/tupled.md) | Creates a version of this function: instead of `n` arguments, it accepts a single tuple argument. |
45-
| [untupled](functions/untupled.md) | Inverse function of `tupled` |
45+
| [untupled](functions/untupled.md) | Inverse function of `tupled`. |

packages/utilities/eff/docs/functions/constFalse.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
function constFalse(): false;
77
```
88

9-
Do nothing and return false
9+
Do nothing and return `false`.
1010

1111
## Returns
1212

packages/utilities/eff/docs/functions/constNull.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
function constNull(): null;
77
```
88

9-
Do nothing and return null
9+
Do nothing and return `null`.
1010

1111
## Returns
1212

packages/utilities/eff/docs/functions/constTrue.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
function constTrue(): true;
77
```
88

9-
Do nothing and return true
9+
Do nothing and return `true`.
1010

1111
## Returns
1212

packages/utilities/eff/docs/functions/constVoid.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
function constVoid(): void;
77
```
88

9-
Do nothing and return void
9+
Do nothing and return `void`.
1010

1111
## Returns
1212

packages/utilities/eff/docs/functions/untupled.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
function untupled<A, B>(f: (a: A) => B): (...a: A) => B;
77
```
88

9-
Inverse function of `tupled`
9+
Inverse function of `tupled`.
1010

1111
## Type Parameters
1212

packages/utilities/eff/docs/type-aliases/unit.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@
66
type unit = undefined;
77
```
88

9-
alias for `undefined`
9+
alias for `undefined`.

packages/utilities/eff/docs/variables/unit.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@
66
unit: undefined;
77
```
88

9-
alias for `undefined`
9+
alias for `undefined`.

packages/utilities/eff/src/index.ts

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -67,12 +67,12 @@
6767
// #region Helpers
6868

6969
/**
70-
* alias for `undefined`
70+
* alias for `undefined`.
7171
*/
7272
export type unit = undefined;
7373

7474
/**
75-
* alias for `undefined`
75+
* alias for `undefined`.
7676
*/
7777
export const unit = undefined;
7878

@@ -332,34 +332,34 @@ export const apply = <A>(a: A) => <B>(self: (a: A) => B): B => self(a);
332332
* Returns a function that always returns the same value.
333333
* @param x - The value to return.
334334
*/
335-
export function constant<T>(x: T) {
335+
export function constant<T>(x: T): () => T {
336336
return () => x;
337337
}
338338

339339
/**
340-
* Do nothing and return void
340+
* Do nothing and return `void`.
341341
*/
342-
export function constVoid() {}
342+
export function constVoid(): void {}
343343

344344
/**
345-
* Do nothing and return null
345+
* Do nothing and return `null`.
346346
*/
347-
export function constNull() {
347+
export function constNull(): null {
348348
return null;
349349
}
350350

351351
/**
352-
* Do nothing and return true
352+
* Do nothing and return `true`.
353353
*/
354-
export function constTrue() {
355-
return true as const;
354+
export function constTrue(): true {
355+
return true;
356356
}
357357

358358
/**
359-
* Do nothing and return false
359+
* Do nothing and return `false`.
360360
*/
361-
export function constFalse() {
362-
return false as const;
361+
export function constFalse(): false {
362+
return false;
363363
}
364364

365365
/**
@@ -438,7 +438,7 @@ export const absurd = <A>(_: never): A => {
438438
export const tupled = <A extends ReadonlyArray<unknown>, B>(f: (...a: A) => B): (a: A) => B => (a) => f(...a);
439439

440440
/**
441-
* Inverse function of `tupled`
441+
* Inverse function of `tupled`.
442442
*
443443
* @param f - The function to be converted.
444444
* @example

0 commit comments

Comments
 (0)