Skip to content
This repository has been archived by the owner on Oct 30, 2022. It is now read-only.

fix: readability improvements #32

Merged
merged 4 commits into from Sep 27, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/example.md
Expand Up @@ -4,7 +4,7 @@ title: A Motivating Example
sidebar_label: A Motivating Example
---

Below is a fully functional example of Unmock in action! You can also view the example on github [here](https://github.com/unmock/unmock-examples/tree/master/starter) and inspect its output results [here](http://htmlpreview.github.io/?https://github.com/unmock/unmock-examples/blob/add-report-to-git/starter/__unmock__/unmock-report.html). It shows the most important concepts of Unmock all rolled into one example.
Below is a fully functional example of Unmock in action! You can also [view the example](https://github.com/unmock/unmock-examples/tree/master/starter) on GitHub and inspect its [output results](http://htmlpreview.github.io/?https://github.com/unmock/unmock-examples/blob/add-report-to-git/starter/__unmock__/unmock-report.html). It shows the most important concepts of Unmock, all rolled into one example.

The example will use TypeScript syntax, although the same is possible in JavaScript. First, let's import everything we need.

Expand Down
2 changes: 1 addition & 1 deletion docs/fuzz.md
Expand Up @@ -4,7 +4,7 @@ title: Fuzz Testing
sidebar_label: Fuzz Testing
---

Because Unmock generates random responses, it is not very useful to test out just one. The real power of unmock comes from testing many different outcomes of interactions with an API. To do this, unmock supports fuzz testing, or the testing of multiple random outcomes, with `unmock.runner`.
Because Unmock generates random responses, it is not very useful to test out just one. The real power of Unmock comes from testing many different outcomes of interactions with an API. To do this, `unmock` supports fuzz testing, or the testing of multiple random outcomes, with `unmock.runner`.

```javascript
import unmock, { u, transform, runner } from "unmock";
Expand Down
8 changes: 4 additions & 4 deletions docs/resources.md
Expand Up @@ -4,9 +4,9 @@ title: More Resources
sidebar_label: More Resources
---

In addition to this documentation, the following resources are available to help you learn unmock.
In addition to this documentation, the following resources are available to help you learn Unmock.

- [Typescript koans](https://github.com/unmock/unmock-ts-koans), a step-by-step wade into unmock using the popular koans method.
- [TypeScript koans](https://github.com/unmock/unmock-ts-koans), a step-by-step wade into Unmock using the popular koans method.
- [Katacoda](https://www.katacoda.com/unmock/scenarios/introduction
), a gentle introduction to unmock that you can do entirely on the web.
- [Our README](https://github.com/unmock/unmock-js), which is basically this documentation in condensed form.
), a gentle introduction to Unmock that you can do entirely on the web.
- [Our README](https://github.com/unmock/unmock-js) is basically this documentation in a condensed format.
2 changes: 1 addition & 1 deletion docs/state.md
Expand Up @@ -28,7 +28,7 @@ In most cases, resetting and redefining the service is all you need. However, wh

## Setting state for a service

Let's revisit the example above, and use the state to make sure we are only returning 200.
Let's revisit the example above, and use the state to make sure we are only returning `200`.

```javascript
import unmock, { u, transform } from "unmock";
Expand Down