docs: add filtering category to getWitherable

gcanti · Oct 3, 2022 · 92f51d5 · 92f51d5
1 parent 5570405
commit 92f51d5
Show file tree

Hide file tree

Showing 10 changed files with 62 additions and 62 deletions.
diff --git a/docs/modules/Either.ts.md b/docs/modules/Either.ts.md
@@ -104,6 +104,7 @@ Added in v2.0.0
   - [filterOrElseW](#filterorelsew)
   - [getCompactable](#getcompactable)
   - [getFilterable](#getfilterable)
+  - [getWitherable](#getwitherable)
 - [folding](#folding)
   - [foldMap](#foldmap)
   - [reduce](#reduce)
@@ -126,7 +127,6 @@ Added in v2.0.0
   - [getEq](#geteq)
   - [getSemigroup](#getsemigroup)
   - [getShow](#getshow)
-  - [getWitherable](#getwitherable)
 - [interop](#interop)
   - [tryCatch](#trycatch)
   - [tryCatchK](#trycatchk)
@@ -751,6 +751,18 @@ export declare const getFilterable: <E>(M: Monoid<E>) => Filterable2C<'Either',
 
 Added in v2.10.0
 
+## getWitherable
+
+Builds `Witherable` instance for `Either` given `Monoid` for the left side
+
+**Signature**
+
+```ts
+export declare const getWitherable: <E>(M: Monoid<E>) => Witherable2C<'Either', E>
+```
+
+Added in v2.0.0
+
 # folding
 
 ## foldMap
@@ -1019,18 +1031,6 @@ export declare const getShow: <E, A>(SE: Show<E>, SA: Show<A>) => Show<Either<E,
 
 Added in v2.0.0
 
-## getWitherable
-
-Builds `Witherable` instance for `Either` given `Monoid` for the left side
-
-**Signature**
-
-```ts
-export declare const getWitherable: <E>(M: Monoid<E>) => Witherable2C<'Either', E>
-```
-
-Added in v2.0.0
-
 # interop
 
 ## tryCatch

diff --git a/docs/modules/Map.ts.md b/docs/modules/Map.ts.md
@@ -19,6 +19,7 @@ Added in v2.0.0
   - [filter](#filter)
   - [filterMap](#filtermap)
   - [getFilterableWithIndex](#getfilterablewithindex)
+  - [getWitherable](#getwitherable)
   - [partition](#partition)
   - [partitionMap](#partitionmap)
   - [separate](#separate)
@@ -42,7 +43,6 @@ Added in v2.0.0
   - [getShow](#getshow)
   - [getUnionMonoid](#getunionmonoid)
   - [getUnionSemigroup](#getunionsemigroup)
-  - [getWitherable](#getwitherable)
 - [mapping](#mapping)
   - [flap](#flap)
   - [map](#map)
@@ -161,6 +161,16 @@ export declare function getFilterableWithIndex<K = never>(): FilterableWithIndex
 
 Added in v2.0.0
 
+## getWitherable
+
+**Signature**
+
+```ts
+export declare function getWitherable<K>(O: Ord<K>): Witherable2C<URI, K> & TraversableWithIndex2C<URI, K, K>
+```
+
+Added in v2.0.0
+
 ## partition
 
 **Signature**
@@ -387,16 +397,6 @@ export declare const getUnionSemigroup: <K, A>(E: Eq<K>, S: Semigroup<A>) => Sem
 
 Added in v2.11.0
 
-## getWitherable
-
-**Signature**
-
-```ts
-export declare function getWitherable<K>(O: Ord<K>): Witherable2C<URI, K> & TraversableWithIndex2C<URI, K, K>
-```
-
-Added in v2.0.0
-
 # mapping
 
 ## flap

diff --git a/docs/modules/ReadonlyMap.ts.md b/docs/modules/ReadonlyMap.ts.md
@@ -25,6 +25,7 @@ Added in v2.5.0
   - [filter](#filter)
   - [filterMap](#filtermap)
   - [getFilterableWithIndex](#getfilterablewithindex)
+  - [getWitherable](#getwitherable)
   - [partition](#partition)
   - [partitionMap](#partitionmap)
   - [separate](#separate)
@@ -49,7 +50,6 @@ Added in v2.5.0
   - [getShow](#getshow)
   - [getUnionMonoid](#getunionmonoid)
   - [getUnionSemigroup](#getunionsemigroup)
-  - [getWitherable](#getwitherable)
 - [mapping](#mapping)
   - [flap](#flap)
   - [map](#map)
@@ -235,6 +235,16 @@ export declare function getFilterableWithIndex<K = never>(): FilterableWithIndex
 
 Added in v2.5.0
 
+## getWitherable
+
+**Signature**
+
+```ts
+export declare function getWitherable<K>(O: Ord<K>): Witherable2C<URI, K> & TraversableWithIndex2C<URI, K, K>
+```
+
+Added in v2.5.0
+
 ## partition
 
 **Signature**
@@ -479,16 +489,6 @@ export declare const getUnionSemigroup: <K, A>(E: Eq<K>, S: Semigroup<A>) => Sem
 
 Added in v2.11.0
 
-## getWitherable
-
-**Signature**
-
-```ts
-export declare function getWitherable<K>(O: Ord<K>): Witherable2C<URI, K> & TraversableWithIndex2C<URI, K, K>
-```
-
-Added in v2.5.0
-
 # mapping
 
 ## flap

diff --git a/docs/modules/ReadonlyRecord.ts.md b/docs/modules/ReadonlyRecord.ts.md
@@ -30,6 +30,7 @@ Added in v2.5.0
   - [compact](#compact)
   - [filter](#filter)
   - [filterMap](#filtermap)
+  - [getWitherable](#getwitherable)
   - [partition](#partition)
   - [partitionMap](#partitionmap)
   - [separate](#separate)
@@ -54,7 +55,6 @@ Added in v2.5.0
   - [getShow](#getshow)
   - [getUnionMonoid](#getunionmonoid)
   - [getUnionSemigroup](#getunionsemigroup)
-  - [getWitherable](#getwitherable)
 - [mapping](#mapping)
   - [flap](#flap)
 - [model](#model)
@@ -377,6 +377,16 @@ assert.deepStrictEqual(filterMap(f)({ a: 'foo', b: 'bar', c: 'verylong' }), {
 
 Added in v2.5.0
 
+## getWitherable
+
+**Signature**
+
+```ts
+export declare const getWitherable: (O: Ord<string>) => Witherable1<URI>
+```
+
+Added in v2.11.0
+
 ## partition
 
 Partition a `ReadonlyRecord` into two parts according to a `Predicate`.
@@ -844,16 +854,6 @@ assert.deepStrictEqual(sReadonlyRecord.concat({ a: 1, b: 2 }, { b: 3, c: 4 }), {
 
 Added in v2.11.0
 
-## getWitherable
-
-**Signature**
-
-```ts
-export declare const getWitherable: (O: Ord<string>) => Witherable1<URI>
-```
-
-Added in v2.11.0
-
 # mapping
 
 ## flap

diff --git a/docs/modules/Record.ts.md b/docs/modules/Record.ts.md
@@ -23,6 +23,7 @@ Added in v2.0.0
   - [compact](#compact)
   - [filter](#filter)
   - [filterMap](#filtermap)
+  - [getWitherable](#getwitherable)
   - [partition](#partition)
   - [partitionMap](#partitionmap)
   - [separate](#separate)
@@ -47,7 +48,6 @@ Added in v2.0.0
   - [getShow](#getshow)
   - [getUnionMonoid](#getunionmonoid)
   - [getUnionSemigroup](#getunionsemigroup)
-  - [getWitherable](#getwitherable)
 - [mapping](#mapping)
   - [flap](#flap)
   - [map](#map)
@@ -263,6 +263,16 @@ assert.deepStrictEqual(filterMap(f)({ a: 'foo', b: 'bar', c: 'verylong' }), {
 
 Added in v2.0.0
 
+## getWitherable
+
+**Signature**
+
+```ts
+export declare const getWitherable: (O: Ord<string>) => Witherable1<URI>
+```
+
+Added in v2.11.0
+
 ## partition
 
 Partition a `Record` into two parts according to a `Predicate`.
@@ -722,16 +732,6 @@ assert.deepStrictEqual(sRecord.concat({ a: 1, b: 2 }, { b: 3, c: 4 }), { a: 1, b
 
 Added in v2.11.0
 
-## getWitherable
-
-**Signature**
-
-```ts
-export declare const getWitherable: (O: Ord<string>) => Witherable1<URI>
-```
-
-Added in v2.11.0
-
 # mapping
 
 ## flap

diff --git a/src/Either.ts b/src/Either.ts
@@ -312,7 +312,7 @@ export const getFilterable = <E>(M: Monoid<E>): Filterable2C<URI, E> => {
 /**
  * Builds `Witherable` instance for `Either` given `Monoid` for the left side
  *
- * @category instances
+ * @category filtering
  * @since 2.0.0
  */
 export const getWitherable = <E>(M: Monoid<E>): Witherable2C<URI, E> => {

diff --git a/src/Map.ts b/src/Map.ts
@@ -661,7 +661,7 @@ export function getFilterableWithIndex<K = never>(): FilterableWithIndex2C<URI,
 }
 
 /**
- * @category instances
+ * @category filtering
  * @since 2.0.0
  */
 export function getWitherable<K>(O: Ord<K>): Witherable2C<URI, K> & TraversableWithIndex2C<URI, K, K> {

diff --git a/src/ReadonlyMap.ts b/src/ReadonlyMap.ts
@@ -1051,7 +1051,7 @@ export const getTraversableWithIndex = <K>(O: Ord<K>): TraversableWithIndex2C<UR
 }
 
 /**
- * @category instances
+ * @category filtering
  * @since 2.5.0
  */
 export function getWitherable<K>(O: Ord<K>): Witherable2C<URI, K> & TraversableWithIndex2C<URI, K, K> {

diff --git a/src/ReadonlyRecord.ts b/src/ReadonlyRecord.ts
@@ -2017,7 +2017,7 @@ export const getTraversableWithIndex = (O: Ord<string>): TraversableWithIndex1<U
 })
 
 /**
- * @category instances
+ * @category filtering
  * @since 2.11.0
  */
 export const getWitherable = (O: Ord<string>): Witherable1<URI> => {

diff --git a/src/Record.ts b/src/Record.ts
@@ -1519,7 +1519,7 @@ export const getTraversableWithIndex = (O: Ord<string>): TraversableWithIndex1<U
 })
 
 /**
- * @category instances
+ * @category filtering
  * @since 2.11.0
  */
 export const getWitherable = (O: Ord<string>): Witherable1<URI> => {