Skip to content

Commit 5ccb077

Browse files
leebyronleebyron
committed
Doc updates
1 parent ea91a3a commit 5ccb077

File tree

2 files changed

+14
-12
lines changed

2 files changed

+14
-12
lines changed

‎dist/immutable.d.ts

+7-6
Original file line numberDiff line numberDiff line change
@@ -1108,8 +1108,8 @@ declare module 'immutable' {
11081108
*
11091109
* Seq is often used to provide a rich collection API to JavaScript Object.
11101110
*
1111-
* Immutable.Seq({ x: 0, y: 1, z: 2 }).map(v => v * 2).toObject();
1112-
* // { x: 0, y: 2, z: 4 }
1111+
* Immutable.Seq({ x: 0, y: 1, z: 2 }).map(v => v * 2).toObject();
1112+
* // { x: 0, y: 2, z: 4 }
11131113
*/
11141114

11151115
export module Seq {
@@ -1188,7 +1188,7 @@ declare module 'immutable' {
11881188

11891189

11901190
/**
1191-
* A `Seq` which represents key-value pairs.
1191+
* `Seq` which represents key-value pairs.
11921192
*/
11931193
export module KeyedSeq {}
11941194

@@ -1214,7 +1214,7 @@ declare module 'immutable' {
12141214

12151215

12161216
/**
1217-
* A `Seq` which represents an ordered indexed list of values.
1217+
* `Seq` which represents an ordered indexed list of values.
12181218
*/
12191219
export module IndexedSeq {
12201220

@@ -1245,7 +1245,7 @@ declare module 'immutable' {
12451245
}
12461246

12471247
/**
1248-
* A `Seq` which represents a set of values.
1248+
* `Seq` which represents a set of values.
12491249
*
12501250
* Because `Seq` are often lazy, `SetSeq` does not provide the same guarantee
12511251
* of value uniqueness as the concrete `Set`.
@@ -2222,7 +2222,8 @@ declare module 'immutable' {
22222222

22232223

22242224
/**
2225-
* Collection is the base class for concrete data structures.
2225+
* Collection is the abstract base class for concrete data structures. It
2226+
* cannot be constructed directly.
22262227
*
22272228
* Implementations should extend one of the subclasses, `KeyedCollection`,
22282229
* `IndexedCollection`, or `SetCollection`.

‎type-definitions/Immutable.d.ts

+7-6
Original file line numberDiff line numberDiff line change
@@ -1108,8 +1108,8 @@ declare module 'immutable' {
11081108
*
11091109
* Seq is often used to provide a rich collection API to JavaScript Object.
11101110
*
1111-
* Immutable.Seq({ x: 0, y: 1, z: 2 }).map(v => v * 2).toObject();
1112-
* // { x: 0, y: 2, z: 4 }
1111+
* Immutable.Seq({ x: 0, y: 1, z: 2 }).map(v => v * 2).toObject();
1112+
* // { x: 0, y: 2, z: 4 }
11131113
*/
11141114

11151115
export module Seq {
@@ -1188,7 +1188,7 @@ declare module 'immutable' {
11881188

11891189

11901190
/**
1191-
* A `Seq` which represents key-value pairs.
1191+
* `Seq` which represents key-value pairs.
11921192
*/
11931193
export module KeyedSeq {}
11941194

@@ -1214,7 +1214,7 @@ declare module 'immutable' {
12141214

12151215

12161216
/**
1217-
* A `Seq` which represents an ordered indexed list of values.
1217+
* `Seq` which represents an ordered indexed list of values.
12181218
*/
12191219
export module IndexedSeq {
12201220

@@ -1245,7 +1245,7 @@ declare module 'immutable' {
12451245
}
12461246

12471247
/**
1248-
* A `Seq` which represents a set of values.
1248+
* `Seq` which represents a set of values.
12491249
*
12501250
* Because `Seq` are often lazy, `SetSeq` does not provide the same guarantee
12511251
* of value uniqueness as the concrete `Set`.
@@ -2222,7 +2222,8 @@ declare module 'immutable' {
22222222

22232223

22242224
/**
2225-
* Collection is the base class for concrete data structures.
2225+
* Collection is the abstract base class for concrete data structures. It
2226+
* cannot be constructed directly.
22262227
*
22272228
* Implementations should extend one of the subclasses, `KeyedCollection`,
22282229
* `IndexedCollection`, or `SetCollection`.

0 commit comments

Comments
 (0)