Skip to content

Commit

Permalink
docs: correct documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
gajus committed May 22, 2018
1 parent a916617 commit 1d664d7
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 7 deletions.
8 changes: 5 additions & 3 deletions .README/rules/array-style-complex-type.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,13 @@

_The `--fix` option on the command line automatically fixes problems reported by this rule._

Enforces a particular style for array type annotations for complex types. Type is considered complex in these cases:
Enforces a particular annotation style of complex types.

Type is considered complex in these cases:

* [Maybe type](https://flow.org/en/docs/types/maybe/)
* Function type
* Object type
* [Function type](https://flow.org/en/docs/types/functions/)
* [Object type](https://flow.org/en/docs/types/objects/)
* [Tuple type](https://flow.org/en/docs/types/tuples/)
* [Union type](https://flow.org/en/docs/types/unions/)
* [Intersection type](https://flow.org/en/docs/types/intersections/)
Expand Down
10 changes: 6 additions & 4 deletions .README/rules/array-style-simple-type.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,15 @@

_The `--fix` option on the command line automatically fixes problems reported by this rule._

Enforces a particular style for array type annotations for complex types. Type is considered simple in these cases:
Enforces a particular array type annotation style of simple types.

* Primitive types
* Literal types
Type is considered simple in these cases:

* [Primitive types](https://flow.org/en/docs/types/primitives/)
* [Literal types](https://flow.org/en/docs/types/literals/)
* [Mixed type](https://flow.org/en/docs/types/mixed/)
* [Any type](https://flow.org/en/docs/types/any/)
* Class type
* [Class type](https://flow.org/en/docs/types/classes/)
* [Generic type](https://flow.org/en/docs/types/generics/)
* Array type [shorthand notation](https://flow.org/en/docs/types/arrays/#toc-array-type-shorthand-syntax)

Expand Down

0 comments on commit 1d664d7

Please sign in to comment.