Skip to content

Commit

Permalink
Lint the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
scottmcginness committed Sep 17, 2023
1 parent 05ebe3b commit 3437410
Showing 1 changed file with 27 additions and 22 deletions.
49 changes: 27 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,28 +47,33 @@ This plugin supports the following settings, which are used by multiple rules:
}
}
```
The `name` property can be in any of the following forms:
* A plain name e.g. `describeModule`, which allows:
```
describeModule("example", function() { ... });
```

* A dotted name, e.g. `describe.modifier`, which allows:
```
describe.modifier("example", function() { ... });
```

* A name with parentheses, e.g. `forEach().describe`, which allows:
```
forEach([ 1, 2, 3 ])
.describe("example", function(n) { ... });
```

* Any combination of the above, e.g. `forEach().describeModule.modifier`, which allows:
```
forEach([ 1, 2, 3 ])
.describeModule.modifier("example", function(n) { ... });
```

The `name` property can be in any of the following forms:
* A plain name e.g. `describeModule`, which allows:

```javascript
describeModule("example", function() { ... });
```

* A dotted name, e.g. `describe.modifier`, which allows:

```javascript
describe.modifier("example", function() { ... });
```

* A name with parentheses, e.g. `forEach().describe`, which allows:

```javascript
forEach([ 1, 2, 3 ])
.describe("example", function(n) { ... });
```

* Any combination of the above, e.g. `forEach().describeModule.modifier`, which allows:

```javascript
forEach([ 1, 2, 3 ])
.describeModule.modifier("example", function(n) { ... });
```

## Configs

Expand Down

0 comments on commit 3437410

Please sign in to comment.