Skip to content

Commit 6c731d9

Browse files
docs: fixup small wording issues
1 parent f5bd849 commit 6c731d9

13 files changed

+19
-19
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ In order to know which AST nodes are created for a snippet of TypeScript code yo
1616

1717
> tl;dr: use `npx cz` instead of `git commit`.
1818
19-
Commit messages must follow [Conventional Commit messages guidelines](https://www.conventionalcommits.org/en/v1.0.0/). You can use `npx cz` instead of `git commit` to run a interactive prompt to generate the commit message. We've customize the prompt specifically for this project. For more information see [commitizen](https://github.com/commitizen/cz-cli#readme).
19+
Commit messages must follow [Conventional Commit messages guidelines](https://www.conventionalcommits.org/en/v1.0.0/). You can use `npx cz` instead of `git commit` to run an interactive prompt to generate the commit message. We've customize the prompt specifically for this project. For more information see [commitizen](https://github.com/commitizen/cz-cli#readme).
2020

2121
### How to publish
2222

GETTING_STARTED.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Add `functional` to the plugins section of your `.eslintrc` configuration file.
4242
```
4343

4444
There are several rulesets provided by this plugin.
45-
[See below](#rulesets) for what they are and what rules are including in each.
45+
[See below](#rulesets) for what they are and what rules are included in each.
4646
Enable rulesets via the "extends" property of your `.eslintrc` configuration file.
4747

4848
```jsonc

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -116,11 +116,11 @@ The [below section](#rules) gives details on which rules are enabled by each rul
116116

117117
### No Other Paradigms
118118

119-
| Name                | Description | 💼 | ⚠️ | 🚫 | 🔧 | 💡 ||
120-
| :------------------------------------------------------- | :--------------------------------------------------------------------------- | :------------------------------------- | :-- | :---- | :-- | :-- | :-- |
121-
| [no-classes](docs/rules/no-classes.md) | Disallow classes. | ☑️ ![badge-no-other-paradigms][] ✅ 🔒 | | | | | |
122-
| [no-mixed-types](docs/rules/no-mixed-types.md) | Restrict types so that only members of the same kind of are allowed in them. | ☑️ ![badge-no-other-paradigms][] ✅ 🔒 | | | | | |
123-
| [no-this-expressions](docs/rules/no-this-expressions.md) | Disallow this access. | ![badge-no-other-paradigms][] 🔒 | | ☑️ ✅ | | | |
119+
| Name                | Description | 💼 | ⚠️ | 🚫 | 🔧 | 💡 ||
120+
| :------------------------------------------------------- | :------------------------------------------------------------------------ | :------------------------------------- | :-- | :---- | :-- | :-- | :-- |
121+
| [no-classes](docs/rules/no-classes.md) | Disallow classes. | ☑️ ![badge-no-other-paradigms][] ✅ 🔒 | | | | | |
122+
| [no-mixed-types](docs/rules/no-mixed-types.md) | Restrict types so that only members of the same kind are allowed in them. | ☑️ ![badge-no-other-paradigms][] ✅ 🔒 | | | | | |
123+
| [no-this-expressions](docs/rules/no-this-expressions.md) | Disallow this access. | ![badge-no-other-paradigms][] 🔒 | | ☑️ ✅ | | | |
124124

125125
### No Statements
126126

docs/rules/functional-parameters.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
<!-- end auto-generated rule header -->
66

7-
Disallow use of rest parameters, the `arguments` keyword and enforces that functions take a least 1 parameter.
7+
Disallow use of rest parameters, the `arguments` keyword and enforces that functions take at least 1 parameter.
88

99
## Rule Details
1010

@@ -130,7 +130,7 @@ There's not much point of having a function that doesn't take any parameters in
130130

131131
Require all functions to have exactly one parameter.
132132

133-
Any function that take takes multiple parameter can be rewritten as a higher-order function that only takes one.
133+
Any function that takes multiple parameter can be rewritten as a higher-order function that only takes one.
134134

135135
Example:
136136

docs/rules/immutable-data.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ const liteOptions = {
9494

9595
### `assumeTypes`
9696

97-
The rule take advantage of TypeScript's typing engine to check if mutation is taking place.
97+
The rule takes advantage of TypeScript's typing engine to check if mutation is taking place.
9898
If you are not using TypeScript, type checking cannot be performed; hence this option exists.
9999

100100
This option will make the rule assume the type of the nodes it is checking are of type Array/Object.

docs/rules/no-classes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ Instead of creating classes, you should use React 0.14's [Stateless Functional C
6666
const Message = ({ message }) => <div>{message}</div>;
6767
```
6868

69-
What about lifecycle methods like `shouldComponentUpdate`? We can use the [recompose](https://github.com/acdlite/recompose) library to apply these optimizations to your Stateless Functional Components. The [recompose](https://github.com/acdlite/recompose) library relies on the fact that your Redux state is immutable to efficiently implement shouldComponentUpdate for you.
69+
What about lifecycle methods like `shouldComponentUpdate`? We can use the [recompose](https://github.com/acdlite/recompose) library to apply these optimizations to your Stateless Functional Components. The [recompose](https://github.com/acdlite/recompose) library relies on the fact that your Redux state is immutable to efficiently implement `shouldComponentUpdate` for you.
7070

7171
```js
7272
import { pure, onlyUpdateForKeys } from "recompose";

docs/rules/no-mixed-types.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Restrict types so that only members of the same kind of are allowed in them (`functional/no-mixed-types`)
1+
# Restrict types so that only members of the same kind are allowed in them (`functional/no-mixed-types`)
22

33
💼 This rule is enabled in the following configs: ☑️ `lite`, `no-other-paradigms`, ✅ `recommended`, 🔒 `strict`.
44

docs/rules/no-this-expressions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
## Rule Details
88

9-
This rule is companion rule to the [no-classes](./no-classes.md) rule.
9+
This rule is a companion rule to the [no-classes](./no-classes.md) rule.
1010
See the its docs for more info.
1111

1212
### ❌ Incorrect

docs/rules/prefer-immutable-types.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
This rule is deigned to be a replacement for
1212
[@typescript-eslint/prefer-readonly-parameter-types](https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/docs/rules/prefer-readonly-parameter-types.md)
13-
but also add extra functionality, allowing not just parameters to checked.
13+
but also add extra functionality, allowing not just parameters to be checked.
1414

1515
This rule uses the
1616
[is-immutable-type](https://www.npmjs.com/package/is-immutable-type) library to

docs/rules/prefer-property-signatures.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ There are two ways function members can be declared in interfaces and type alias
1111
The `MethodSignature` and the `PropertySignature` forms seem equivalent, but only the `PropertySignature` form can have a `readonly` modifier.
1212
Because of this any `MethodSignature` will be mutable unless wrapped in the `Readonly` type.
1313

14-
It should be noted however that the `PropertySignature` do not support overloading.
14+
It should be noted however that the `PropertySignature` form does not support overloading.
1515

1616
### ❌ Incorrect
1717

0 commit comments

Comments
 (0)