Skip to content

Commit 39f498c

Browse files
authored
Minor readme improvements (#1913)
Link to the migration guide so that there is a link from the pub and docs sites. Fix an example usage of `completes` after #1896
1 parent 2cb07a3 commit 39f498c

File tree

3 files changed

+10
-2
lines changed

3 files changed

+10
-2
lines changed

pkgs/checks/CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# 0.2.1-dev
2+
13
# 0.2.0
24

35
- **Breaking Changes**

pkgs/checks/README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ value - for instance reading a field or awaiting the result of a Future.
2727

2828
```dart
2929
check(someString).length.equals(expectedLength);
30-
(await check(someFuture).completes()).equals(expectedCompletion);
30+
await check(someFuture).completes(it()..equals(expectedCompletion));
3131
```
3232

3333
Fields can be extracted from objects for checking further properties with the
@@ -102,3 +102,9 @@ extension CustomChecks on Subject<CustomType> {
102102
Subject<Bar> get someField => has((a) => a.someField, 'someField');
103103
}
104104
```
105+
106+
# Migrating from `matcher` (`expect`) expectations
107+
108+
See the [migration guide][].
109+
110+
[migration guide]:https://github.com/dart-lang/test/blob/master/pkgs/checks/doc/migrating_from_matcher.md

pkgs/checks/pubspec.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name: checks
2-
version: 0.2.0
2+
version: 0.2.1-dev
33
description: >-
44
A framework for checking values against expectations and building custom
55
expectations.

0 commit comments

Comments
 (0)