Skip to content

Commit

Permalink
Fix documentation typos (#1373)
Browse files Browse the repository at this point in the history
  • Loading branch information
mlrv authored Jan 18, 2021
1 parent 2f21fa5 commit 9759cb0
Show file tree
Hide file tree
Showing 12 changed files with 32 additions and 32 deletions.
4 changes: 2 additions & 2 deletions docs/modules/Either.ts.md
Original file line number Diff line number Diff line change
Expand Up @@ -1450,7 +1450,7 @@ Added in v2.9.0
## sequenceArray

convert an array of either to an either of array
this function have the same behavior of `A.sequence(E.either)` but it's optimized and perform better
this function has the same behavior of `A.sequence(E.either)` but it's optimized and performs better

**Signature**

Expand Down Expand Up @@ -1487,7 +1487,7 @@ Added in v2.0.0
## traverseArray

map an array using provided function to Either then transform to Either of the array
this function have the same behavior of `A.traverse(E.either)` but it's optimized and perform better
this function has the same behavior of `A.traverse(E.either)` but it's optimized and performs better

**Signature**

Expand Down
4 changes: 2 additions & 2 deletions docs/modules/IO.ts.md
Original file line number Diff line number Diff line change
Expand Up @@ -355,7 +355,7 @@ Added in v2.8.0

transform Array of IO to IO of Array

this function have the same behavior of `A.sequence(IO.io)` but it's stack safe
this function has the same behavior of `A.sequence(IO.io)` but it's stack safe

**Signature**

Expand Down Expand Up @@ -385,7 +385,7 @@ Added in v2.9.0

runs an action for every element in array, and accumulates the results IO in the array.

this function have the same behavior of `A.traverse(IO.io)` but it's stack safe
this function has the same behavior of `A.traverse(IO.io)` but it's stack safe

**Signature**

Expand Down
4 changes: 2 additions & 2 deletions docs/modules/Option.ts.md
Original file line number Diff line number Diff line change
Expand Up @@ -1457,7 +1457,7 @@ Added in v2.0.0

get an array of option and convert it to option of array

this function have the same behavior of `A.sequence(O.option)` but it's optimized and perform better
this function has the same behavior of `A.sequence(O.option)` but it's optimized and performs better

**Signature**

Expand All @@ -1483,7 +1483,7 @@ Added in v2.9.0

Runs an action for every element in array and accumulates the results in option

this function have the same behavior of `A.sequence(O.option)` but it's optimized and perform better
this function has the same behavior of `A.sequence(O.option)` but it's optimized and performs better

**Signature**

Expand Down
4 changes: 2 additions & 2 deletions docs/modules/Reader.ts.md
Original file line number Diff line number Diff line change
Expand Up @@ -494,7 +494,7 @@ Added in v2.8.0

## sequenceArray

this function have the same behavior of `A.sequence(R.reader)` but it's stack safe and optimized
this function has the same behavior of `A.sequence(R.reader)` but it's stack safe and optimized

**Signature**

Expand Down Expand Up @@ -525,7 +525,7 @@ Added in v2.9.0

## traverseArray

this function have the same behavior of `A.traverse(R.reader)` but it's stack safe and optimized
this function has the same behavior of `A.traverse(R.reader)` but it's stack safe and optimized

**Signature**

Expand Down
8 changes: 4 additions & 4 deletions docs/modules/Task.ts.md
Original file line number Diff line number Diff line change
Expand Up @@ -483,7 +483,7 @@ Added in v2.0.0

this function works like `Promise.all` it will get an array of tasks and return a task of array.

this function have the same behavior of `A.sequence(T.task)` but it's stack safe.
this function has the same behavior of `A.sequence(T.task)` but it's stack safe.

> **This function run all task in parallel for sequential use `sequenceSeqArray` **

Expand Down Expand Up @@ -514,7 +514,7 @@ Added in v2.9.0

run tasks in array sequential and give a task of array

this function have the same behavior of `A.sequence(T.taskSeq)` but it's stack safe.
this function has the same behavior of `A.sequence(T.taskSeq)` but it's stack safe.

> **This function run all task sequentially for parallel use `sequenceArray` **

Expand All @@ -530,7 +530,7 @@ Added in v2.9.0

this function map array to task using provided function and transform it to a task of array.

this function have the same behavior of `A.traverse(T.task)` but it's stack safe.
this function has the same behavior of `A.traverse(T.task)` but it's stack safe.

> **This function run all task in parallel for sequential use `traverseSeqArray` **

Expand Down Expand Up @@ -572,7 +572,7 @@ Added in v2.9.0

runs an action for every element in array then run task sequential, and accumulates the results in the array.

this function have the same behavior of `A.traverse(T.taskSeq)` but it's stack safe.
this function has the same behavior of `A.traverse(T.taskSeq)` but it's stack safe.

> **This function run all task sequentially for parallel use `traverseArray` **

Expand Down
8 changes: 4 additions & 4 deletions docs/modules/TaskEither.ts.md
Original file line number Diff line number Diff line change
Expand Up @@ -1025,7 +1025,7 @@ Added in v2.9.0

## sequenceArray

this function have the same behavior of `A.sequence(TE.taskEither)` but it's stack safe and perform better
this function has the same behavior of `A.sequence(TE.taskEither)` but it's stack safe and performs better

_this function run all tasks in parallel and does not bail out, for sequential version use `sequenceSeqArray`_

Expand Down Expand Up @@ -1070,7 +1070,7 @@ Added in v2.9.0

## sequenceSeqArray

this function have the same behavior of `A.sequence(TE.taskEitherSeq)` but it's stack safe and perform better
this function has the same behavior of `A.sequence(TE.taskEitherSeq)` but it's stack safe and performs better

_this function run all tasks in sequential order and bails out on left side of either, for parallel version use `sequenceArray`_

Expand Down Expand Up @@ -1136,7 +1136,7 @@ Added in v2.0.0

## traverseArray

this function have the same behavior of `A.traverse(TE.taskEither)` but it's stack safe and perform better
this function has the same behavior of `A.traverse(TE.taskEither)` but it's stack safe and performs better

_this function run all tasks in parallel and does not bail out, for sequential version use `traverseSeqArray`_

Expand Down Expand Up @@ -1195,7 +1195,7 @@ Added in v2.9.0

## traverseSeqArray

this function have the same behavior of `A.traverse(TE.taskEitherSeq)` but it's stack safe and perform better
this function has the same behavior of `A.traverse(TE.taskEitherSeq)` but it's stack safe and performs better

_this function run all tasks in sequential order and bails out on left side of either, for parallel version use `traverseArray`_

Expand Down
4 changes: 2 additions & 2 deletions src/Either.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1415,7 +1415,7 @@ export const traverseArrayWithIndex = <E, A, B>(f: (index: number, a: A) => Eith

/**
* map an array using provided function to Either then transform to Either of the array
* this function have the same behavior of `A.traverse(E.either)` but it's optimized and perform better
* this function has the same behavior of `A.traverse(E.either)` but it's optimized and performs better
*
* @example
*
Expand Down Expand Up @@ -1452,7 +1452,7 @@ export const traverseArray: <E, A, B>(

/**
* convert an array of either to an either of array
* this function have the same behavior of `A.sequence(E.either)` but it's optimized and perform better
* this function has the same behavior of `A.sequence(E.either)` but it's optimized and performs better
*
* @example
*
Expand Down
4 changes: 2 additions & 2 deletions src/IO.ts
Original file line number Diff line number Diff line change
Expand Up @@ -320,7 +320,7 @@ export const traverseArrayWithIndex: <A, B>(
/**
* runs an action for every element in array, and accumulates the results IO in the array.
*
* this function have the same behavior of `A.traverse(IO.io)` but it's stack safe
* this function has the same behavior of `A.traverse(IO.io)` but it's stack safe
*
* @example
* import * as RA from 'fp-ts/ReadonlyArray'
Expand All @@ -341,7 +341,7 @@ export const traverseArray: <A, B>(f: (a: A) => IO<B>) => (arr: ReadonlyArray<A>
/**
* transform Array of IO to IO of Array
*
* this function have the same behavior of `A.sequence(IO.io)` but it's stack safe
* this function has the same behavior of `A.sequence(IO.io)` but it's stack safe
*
* @example
* import * as RA from 'fp-ts/ReadonlyArray'
Expand Down
4 changes: 2 additions & 2 deletions src/Option.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1314,7 +1314,7 @@ export const traverseArrayWithIndex = <A, B>(f: (index: number, a: A) => Option<
/**
* Runs an action for every element in array and accumulates the results in option
*
* this function have the same behavior of `A.sequence(O.option)` but it's optimized and perform better
* this function has the same behavior of `A.sequence(O.option)` but it's optimized and performs better
*
* @example
*
Expand All @@ -1335,7 +1335,7 @@ export const traverseArray: <A, B>(f: (a: A) => Option<B>) => (arr: ReadonlyArra
/**
* get an array of option and convert it to option of array
*
* this function have the same behavior of `A.sequence(O.option)` but it's optimized and perform better
* this function has the same behavior of `A.sequence(O.option)` but it's optimized and performs better
*
* @example
*
Expand Down
4 changes: 2 additions & 2 deletions src/Reader.ts
Original file line number Diff line number Diff line change
Expand Up @@ -424,7 +424,7 @@ export const traverseArrayWithIndex: <R, A, B>(
) => (arr: ReadonlyArray<A>) => Reader<R, ReadonlyArray<B>> = (f) => (arr) => (r) => arr.map((x, i) => f(i, x)(r))

/**
* this function have the same behavior of `A.traverse(R.reader)` but it's stack safe and optimized
* this function has the same behavior of `A.traverse(R.reader)` but it's stack safe and optimized
*
* @example
* import * as RA from 'fp-ts/ReadonlyArray'
Expand All @@ -443,7 +443,7 @@ export const traverseArray: <R, A, B>(
) => (arr: ReadonlyArray<A>) => Reader<R, ReadonlyArray<B>> = (f) => traverseArrayWithIndex((_, a) => f(a))

/**
* this function have the same behavior of `A.sequence(R.reader)` but it's stack safe and optimized
* this function has the same behavior of `A.sequence(R.reader)` but it's stack safe and optimized
*
* @example
* import * as RA from 'fp-ts/ReadonlyArray'
Expand Down
8 changes: 4 additions & 4 deletions src/Task.ts
Original file line number Diff line number Diff line change
Expand Up @@ -444,7 +444,7 @@ export const traverseArrayWithIndex: <A, B>(
/**
* this function map array to task using provided function and transform it to a task of array.
*
* this function have the same behavior of `A.traverse(T.task)` but it's stack safe.
* this function has the same behavior of `A.traverse(T.task)` but it's stack safe.
*
* > **This function run all task in parallel for sequential use `traverseSeqArray` **
*
Expand All @@ -467,7 +467,7 @@ export const traverseArray: <A, B>(f: (a: A) => Task<B>) => (arr: ReadonlyArray<
/**
* this function works like `Promise.all` it will get an array of tasks and return a task of array.
*
* this function have the same behavior of `A.sequence(T.task)` but it's stack safe.
* this function has the same behavior of `A.sequence(T.task)` but it's stack safe.
*
* > **This function run all task in parallel for sequential use `sequenceSeqArray` **
*
Expand Down Expand Up @@ -506,7 +506,7 @@ export const traverseSeqArrayWithIndex: <A, B>(
/**
* runs an action for every element in array then run task sequential, and accumulates the results in the array.
*
* this function have the same behavior of `A.traverse(T.taskSeq)` but it's stack safe.
* this function has the same behavior of `A.traverse(T.taskSeq)` but it's stack safe.
*
* > **This function run all task sequentially for parallel use `traverseArray` **
*
Expand All @@ -520,7 +520,7 @@ export const traverseSeqArray: <A, B>(f: (a: A) => Task<B>) => (arr: ReadonlyArr
/**
* run tasks in array sequential and give a task of array
*
* this function have the same behavior of `A.sequence(T.taskSeq)` but it's stack safe.
* this function has the same behavior of `A.sequence(T.taskSeq)` but it's stack safe.
*
* > **This function run all task sequentially for parallel use `sequenceArray` **
*
Expand Down
8 changes: 4 additions & 4 deletions src/TaskEither.ts
Original file line number Diff line number Diff line change
Expand Up @@ -952,7 +952,7 @@ export const traverseArrayWithIndex: <A, B, E>(
pipe(arr, T.traverseArrayWithIndex(f), T.map(E.sequenceArray))

/**
* this function have the same behavior of `A.traverse(TE.taskEither)` but it's stack safe and perform better
* this function has the same behavior of `A.traverse(TE.taskEither)` but it's stack safe and performs better
*
* *this function run all tasks in parallel and does not bail out, for sequential version use `traverseSeqArray`*
*
Expand Down Expand Up @@ -992,7 +992,7 @@ export const traverseArray: <A, B, E>(
) => (arr: ReadonlyArray<A>) => TaskEither<E, ReadonlyArray<B>> = (f) => traverseArrayWithIndex((_, a) => f(a))

/**
* this function have the same behavior of `A.sequence(TE.taskEither)` but it's stack safe and perform better
* this function has the same behavior of `A.sequence(TE.taskEither)` but it's stack safe and performs better
*
* *this function run all tasks in parallel and does not bail out, for sequential version use `sequenceSeqArray`*
*
Expand Down Expand Up @@ -1051,7 +1051,7 @@ export const traverseSeqArrayWithIndex: <A, B, E>(
}

/**
* this function have the same behavior of `A.traverse(TE.taskEitherSeq)` but it's stack safe and perform better
* this function has the same behavior of `A.traverse(TE.taskEitherSeq)` but it's stack safe and performs better
*
* *this function run all tasks in sequential order and bails out on left side of either, for parallel version use `traverseArray`*
*
Expand All @@ -1062,7 +1062,7 @@ export const traverseSeqArray: <A, B, E>(
) => (arr: ReadonlyArray<A>) => TaskEither<E, ReadonlyArray<B>> = (f) => traverseSeqArrayWithIndex((_, a) => f(a))

/**
* this function have the same behavior of `A.sequence(TE.taskEitherSeq)` but it's stack safe and perform better
* this function has the same behavior of `A.sequence(TE.taskEitherSeq)` but it's stack safe and performs better
*
* *this function run all tasks in sequential order and bails out on left side of either, for parallel version use `sequenceArray`*
*
Expand Down

0 comments on commit 9759cb0

Please sign in to comment.