Skip to content

Commit 6f613f0

Browse files
authored
doc(README): minor corrections (#89)
Closes #88
1 parent e0d6155 commit 6f613f0

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

README.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -161,10 +161,11 @@ The following sections are an overview of each implementation.
161161
### JsonCacheMem
162162

163163
[JsonCacheMem](https://pub.dev/documentation/json_cache/latest/json_cache/JsonCacheMem-class.html)
164-
is is a thread-safe in-memory implementation of the `JsonCache` interface.
164+
is a thread-safe in-memory implementation of the `JsonCache` interface.
165165
Moreover, it encapsulates a secondary cache or "slower level2 cache". Typically,
166-
the secondary cache instance is responsible for the local cache; that is, it is
167-
the cache instance that persists data on the user's device.
166+
this secondary cache instance is responsible for the local cache; that is, it is
167+
the `JsonCache` implementation that actually persists the data on the user's
168+
device.
168169

169170
#### Typical Usage
170171

@@ -356,7 +357,7 @@ void main() {
356357
### Fake Implementations
357358

358359
In addition to mocking, there is another approach to unit testing: making use of
359-
a 'fake' implementation. Usually this so called 'fake' implementation provides
360+
a 'fake' implementation. Usually this so-called 'fake' implementation provides
360361
the functionality required by the `JsonCache` interface without touching the
361362
device's local storage. An example of this implementation is the
362363
[JsonCacheFake](https://pub.dev/documentation/json_cache/latest/json_cache/JsonCacheFake-class.html)
@@ -369,7 +370,8 @@ off putting all your test code inside a `tester.runAsync` method; otherwise,
369370
your test case may stall due to a
370371
[deadlock](https://en.wikipedia.org/wiki/Deadlock) caused by a [race
371372
condition](https://stackoverflow.com/questions/34510/what-is-a-race-condition)
372-
as there might be multiple `Futures` trying to access the same resources.
373+
as there might be multiple `Futures` trying to access the same resources at the
374+
same time.
373375

374376
#### Example of Widget Test Code
375377

@@ -425,10 +427,10 @@ This should launch the demo application on Chrome in debug mode.
425427

426428
Contributors are welcome!
427429

428-
1. Open an issue regarding an improvement, a bug you noticed, or ask to be
430+
1. Open an **issue** regarding an improvement, a bug you noticed, or ask to be
429431
assigned to an existing one.
430-
2. If the issue is confirmed, fork the repository, do the changes on a separate
431-
branch and make a Pull Request.
432+
2. If the issue is confirmed, **fork** the repository, do the changes on a
433+
separate branch and make a **Pull Request**.
432434
3. After review and acceptance, the PR is merged and closed.
433435

434436
Make sure the command below **passes** before making a Pull Request.

0 commit comments

Comments
 (0)