| Index: packages/collection/README.md
|
| diff --git a/packages/collection/README.md b/packages/collection/README.md
|
| index 8772e6552a34198f21151b062551385dbe19219c..a7985fa47dd1b0cdcb90c74883cdb7d3cb2dd25c 100644
|
| --- a/packages/collection/README.md
|
| +++ b/packages/collection/README.md
|
| @@ -1,47 +1,26 @@
|
| -Contains a number libraries
|
| -with utility functions and classes that makes working with collections easier.
|
| -
|
| -## Using
|
| -
|
| -The `collection` package can be imported as separate libraries, or
|
| -in totality:
|
| -
|
| -```dart
|
| -import 'package:collection/algorithms.dart';
|
| -import 'package:collection/equality.dart';
|
| -import 'package:collection/iterable_zip.dart';
|
| -import 'package:collection/priority_queue.dart';
|
| -import 'package:collection/wrappers.dart';
|
| -```
|
| -
|
| -or
|
| -
|
| -```dart
|
| -import 'package:collection/collection.dart';
|
| -```
|
| +Contains utility functions and classes in the style of `dart:collection` to make
|
| +working with collections easier.
|
|
|
| ## Algorithms
|
|
|
| -The algorithms library contains functions that operate on lists.
|
| +The package contains functions that operate on lists.
|
|
|
| It contains ways to shuffle a `List`, do binary search on a sorted `List`, and
|
| various sorting algorithms.
|
|
|
| -
|
| ## Equality
|
|
|
| -The equality library gives a way to specify equality of elements and
|
| -collections.
|
| +The package provides a way to specify the equality of elements and collections.
|
|
|
| Collections in Dart have no inherent equality. Two sets are not equal, even
|
| if they contain exactly the same objects as elements.
|
|
|
| -The equality library provides a way to say define such an equality. In this
|
| +The `Equality` interface provides a way to say define such an equality. In this
|
| case, for example, `const SetEquality(const IdentityEquality())` is an equality
|
| that considers two sets equal exactly if they contain identical elements.
|
|
|
| -The library provides ways to define equalities on `Iterable`s, `List`s, `Set`s,
|
| -and `Map`s, as well as combinations of these, such as:
|
| +Equalities are provided for `Iterable`s, `List`s, `Set`s, and `Map`s, as well as
|
| +combinations of these, such as:
|
|
|
| ```dart
|
| const MapEquality(const IdentityEquality(), const ListEquality());
|
| @@ -50,20 +29,17 @@ const MapEquality(const IdentityEquality(), const ListEquality());
|
| This equality considers maps equal if they have identical keys, and the
|
| corresponding values are lists with equal (`operator==`) values.
|
|
|
| -
|
| ## Iterable Zip
|
|
|
| Utilities for "zipping" a list of iterables into an iterable of lists.
|
|
|
| -
|
| ## Priority Queue
|
|
|
| An interface and implementation of a priority queue.
|
|
|
| -
|
| ## Wrappers
|
|
|
| -The wrappers library contains classes that "wrap" a collection.
|
| +The package contains classes that "wrap" a collection.
|
|
|
| A wrapper class contains an object of the same type, and it forwards all
|
| methods to the wrapped object.
|
|
|