Skip to content

Commit 64c1180

Browse files
committed
Minor corrections in readme and changelog
1 parent 454f370 commit 64c1180

File tree

2 files changed

+5
-4
lines changed

2 files changed

+5
-4
lines changed

CHANGELOG.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,11 @@
1414
* `PersistentList` extends `ImmutableList` and `PersistentCollection`, and provides modification operations
1515
* `PersistentSet` extends `ImmutableSet` and `PersistentCollection`, and provides modification operations
1616
* `PersistentMap` extends `ImmutableMap`, and provides modification operations and builder
17-
- `plus`, `minus` and `mutate` extension functions are available only persistent collections
17+
- `plus`, `minus` and `mutate` extension functions are available only for persistent collections
1818
- Deprecate `immutableXOf()` top-level functions and introduce `persistentXOf()`
1919
- `toImmutableX()` extension functions return `ImmutableX`
2020
- Introduce `toPersistentX()` extension functions that return `PersistentX`
21+
- Document public API
2122

2223
#### Replace PCollection-based prototypes with custom performant implementations
2324

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,13 +39,13 @@ This library provides interfaces for immutable and persistent collections.
3939
| `PersistentMap.Builder` | `MutableMap` |
4040

4141

42-
To instantiate an empty persistent collection or a collection with the specified elements the functions
43-
`persistentListOf`, `persistentSetOf`, and `persistentMapOf` can be used.
42+
To instantiate an empty persistent collection or a collection with the specified elements use the functions
43+
`persistentListOf`, `persistentSetOf`, and `persistentMapOf`.
4444

4545
The default implementations of `PersistentSet` and `PersistentMap`, which are returned by `persistentSetOf` and `persistentMapOf`,
4646
preserve the element insertion order during iteration. This comes at expense of maintaining more complex data structures.
4747
If the order of elements doesn't matter, the more efficient implementations returned by the functions
48-
`persistentHashSetOf` and `persistentHashMapOf` could be used.
48+
`persistentHashSetOf` and `persistentHashMapOf` can be used.
4949

5050
### Operations
5151

0 commit comments

Comments
 (0)