docs: add getFoldableWithIndex to folding category

gcanti · Oct 5, 2022 · 102f898 · 102f898
1 parent 92f51d5
commit 102f898
Show file tree

Hide file tree

Showing 8 changed files with 54 additions and 54 deletions.
diff --git a/docs/modules/Map.ts.md b/docs/modules/Map.ts.md
@@ -27,6 +27,7 @@ Added in v2.0.0
   - [foldMap](#foldmap)
   - [foldMapWithIndex](#foldmapwithindex)
   - [getFoldable](#getfoldable)
+  - [getFoldableWithIndex](#getfoldablewithindex)
   - [reduce](#reduce)
   - [reduceRight](#reduceright)
   - [reduceRightWithIndex](#reducerightwithindex)
@@ -37,7 +38,6 @@ Added in v2.0.0
   - [Functor](#functor)
   - [getDifferenceMagma](#getdifferencemagma)
   - [getEq](#geteq)
-  - [getFoldableWithIndex](#getfoldablewithindex)
   - [getIntersectionSemigroup](#getintersectionsemigroup)
   - [getMonoid](#getmonoid)
   - [getShow](#getshow)
@@ -241,6 +241,16 @@ export declare const getFoldable: <K>(O: Ord<K>) => Foldable2C<'Map', K>
 
 Added in v2.11.0
 
+## getFoldableWithIndex
+
+**Signature**
+
+```ts
+export declare const getFoldableWithIndex: <K>(O: Ord<K>) => FoldableWithIndex2C<'Map', K, K>
+```
+
+Added in v2.10.0
+
 ## reduce
 
 **Signature**
@@ -335,16 +345,6 @@ export declare const getEq: <K, A>(SK: Eq<K>, SA: Eq<A>) => Eq<Map<K, A>>
 
 Added in v2.0.0
 
-## getFoldableWithIndex
-
-**Signature**
-
-```ts
-export declare const getFoldableWithIndex: <K>(O: Ord<K>) => FoldableWithIndex2C<'Map', K, K>
-```
-
-Added in v2.10.0
-
 ## getIntersectionSemigroup
 
 **Signature**

diff --git a/docs/modules/ReadonlyMap.ts.md b/docs/modules/ReadonlyMap.ts.md
@@ -33,6 +33,7 @@ Added in v2.5.0
   - [foldMap](#foldmap)
   - [foldMapWithIndex](#foldmapwithindex)
   - [getFoldable](#getfoldable)
+  - [getFoldableWithIndex](#getfoldablewithindex)
   - [reduce](#reduce)
   - [reduceRight](#reduceright)
   - [reduceRightWithIndex](#reducerightwithindex)
@@ -43,7 +44,6 @@ Added in v2.5.0
   - [Functor](#functor)
   - [getDifferenceMagma](#getdifferencemagma)
   - [getEq](#geteq)
-  - [getFoldableWithIndex](#getfoldablewithindex)
   - [getFunctorWithIndex](#getfunctorwithindex)
   - [getIntersectionSemigroup](#getintersectionsemigroup)
   - [getMonoid](#getmonoid)
@@ -321,6 +321,16 @@ export declare const getFoldable: <K>(O: Ord<K>) => Foldable2C<'ReadonlyMap', K>
 
 Added in v2.10.0
 
+## getFoldableWithIndex
+
+**Signature**
+
+```ts
+export declare const getFoldableWithIndex: <K>(O: Ord<K>) => FoldableWithIndex2C<'ReadonlyMap', K, K>
+```
+
+Added in v2.10.0
+
 ## reduce
 
 **Signature**
@@ -417,16 +427,6 @@ export declare function getEq<K, A>(SK: Eq<K>, SA: Eq<A>): Eq<ReadonlyMap<K, A>>
 
 Added in v2.5.0
 
-## getFoldableWithIndex
-
-**Signature**
-
-```ts
-export declare const getFoldableWithIndex: <K>(O: Ord<K>) => FoldableWithIndex2C<'ReadonlyMap', K, K>
-```
-
-Added in v2.10.0
-
 ## getFunctorWithIndex
 
 **Signature**

diff --git a/docs/modules/ReadonlyRecord.ts.md b/docs/modules/ReadonlyRecord.ts.md
@@ -39,6 +39,7 @@ Added in v2.5.0
 - [folding](#folding)
   - [foldMap](#foldmap)
   - [getFoldable](#getfoldable)
+  - [getFoldableWithIndex](#getfoldablewithindex)
   - [reduce](#reduce)
   - [reduceRight](#reduceright)
 - [instances](#instances)
@@ -49,7 +50,6 @@ Added in v2.5.0
   - [FunctorWithIndex](#functorwithindex)
   - [getDifferenceMagma](#getdifferencemagma)
   - [getEq](#geteq)
-  - [getFoldableWithIndex](#getfoldablewithindex)
   - [getIntersectionSemigroup](#getintersectionsemigroup)
   - [getMonoid](#getmonoid)
   - [getShow](#getshow)
@@ -554,6 +554,19 @@ export declare const getFoldable: (O: Ord<string>) => Foldable1<URI>
 
 Added in v2.11.0
 
+## getFoldableWithIndex
+
+Produces a `FoldableWithIndex1` instance for a `ReadonlyRecord`, using the
+provided `Ord` to sort the `ReadonlyRecord`'s entries by key.
+
+**Signature**
+
+```ts
+export declare const getFoldableWithIndex: (O: Ord<string>) => FoldableWithIndex1<URI, string>
+```
+
+Added in v2.11.0
+
 ## reduce
 
 Reduces a `ReadonlyRecord` passing each value to the iterating function.
@@ -711,19 +724,6 @@ assert.deepStrictEqual(eq.equals({ a: 'foo' }, { a: 'foo' }), true)
 
 Added in v2.5.0
 
-## getFoldableWithIndex
-
-Produces a `FoldableWithIndex1` instance for a `ReadonlyRecord`, using the
-provided `Ord` to sort the `ReadonlyRecord`'s entries by key.
-
-**Signature**
-
-```ts
-export declare const getFoldableWithIndex: (O: Ord<string>) => FoldableWithIndex1<URI, string>
-```
-
-Added in v2.11.0
-
 ## getIntersectionSemigroup
 
 Given a `Semigroup` in the base type, it produces a `Semigroup`

diff --git a/docs/modules/Record.ts.md b/docs/modules/Record.ts.md
@@ -32,6 +32,7 @@ Added in v2.0.0
 - [folding](#folding)
   - [foldMap](#foldmap)
   - [getFoldable](#getfoldable)
+  - [getFoldableWithIndex](#getfoldablewithindex)
   - [reduce](#reduce)
   - [reduceRight](#reduceright)
 - [instances](#instances)
@@ -42,7 +43,6 @@ Added in v2.0.0
   - [FunctorWithIndex](#functorwithindex)
   - [getDifferenceMagma](#getdifferencemagma)
   - [getEq](#geteq)
-  - [getFoldableWithIndex](#getfoldablewithindex)
   - [getIntersectionSemigroup](#getintersectionsemigroup)
   - [getMonoid](#getmonoid)
   - [getShow](#getshow)
@@ -436,6 +436,19 @@ export declare const getFoldable: (O: Ord<string>) => Foldable1<URI>
 
 Added in v2.11.0
 
+## getFoldableWithIndex
+
+Produces a `FoldableWithIndex1` instance for a `Record`, using the
+provided `Ord` to sort the `Record`'s entries by key.
+
+**Signature**
+
+```ts
+export declare const getFoldableWithIndex: (O: Ord<string>) => FoldableWithIndex1<URI, string>
+```
+
+Added in v2.11.0
+
 ## reduce
 
 Reduces a `Record` passing each value to the iterating function.
@@ -589,19 +602,6 @@ assert.deepStrictEqual(eq.equals({ a: 'foo' }, { a: 'foo' }), true)
 
 Added in v2.0.0
 
-## getFoldableWithIndex
-
-Produces a `FoldableWithIndex1` instance for a `Record`, using the
-provided `Ord` to sort the `Record`'s entries by key.
-
-**Signature**
-
-```ts
-export declare const getFoldableWithIndex: (O: Ord<string>) => FoldableWithIndex1<URI, string>
-```
-
-Added in v2.11.0
-
 ## getIntersectionSemigroup
 
 Given a `Semigroup` in the base type, it produces a `Semigroup`

diff --git a/src/Map.ts b/src/Map.ts
@@ -742,7 +742,7 @@ export const reduceRightWithIndex: <K>(O: Ord<K>) => <B, A>(b: B, f: (k: K, a: A
   RM.reduceRightWithIndex
 
 /**
- * @category instances
+ * @category folding
  * @since 2.10.0
  */
 export const getFoldableWithIndex = <K>(O: Ord<K>): FoldableWithIndex2C<URI, K, K> => {

diff --git a/src/ReadonlyMap.ts b/src/ReadonlyMap.ts
@@ -955,7 +955,7 @@ export const reduceRightWithIndex = <K>(
 }
 
 /**
- * @category instances
+ * @category folding
  * @since 2.10.0
  */
 export const getFoldableWithIndex = <K>(O: Ord<K>): FoldableWithIndex2C<URI, K, K> => {

diff --git a/src/ReadonlyRecord.ts b/src/ReadonlyRecord.ts
@@ -1919,7 +1919,7 @@ export const getFoldable = (O: Ord<string>): Foldable1<URI> => ({
  * Produces a `FoldableWithIndex1` instance for a `ReadonlyRecord`, using the
  * provided `Ord` to sort the `ReadonlyRecord`'s entries by key.
  *
- * @category instances
+ * @category folding
  * @since 2.11.0
  */
 export const getFoldableWithIndex = (O: Ord<string>): FoldableWithIndex1<URI, string> => ({

diff --git a/src/Record.ts b/src/Record.ts
@@ -1421,7 +1421,7 @@ export const getFoldable = (O: Ord<string>): Foldable1<URI> => ({
  * Produces a `FoldableWithIndex1` instance for a `Record`, using the
  * provided `Ord` to sort the `Record`'s entries by key.
  *
- * @category instances
+ * @category folding
  * @since 2.11.0
  */
 export const getFoldableWithIndex = (O: Ord<string>): FoldableWithIndex1<URI, string> => ({