Skip to content

Commit b93ffae

Browse files
thiagodebastosNoviny
authored andcommitted
Fix typos (#68)
* Fix typos * fix typos update broken link
1 parent 287e4b4 commit b93ffae

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

packages/kind2string/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Kind 2 String - a parser for extract-react-types
22

3-
Kind 2 String is designed to take the data structures outputted by [extract-react-types](https://www.npmjs.com/package/extract-react-types) and convert it down to a (useful) string, as well as performing safe traversal through the output of `extract-react-types` so that trying to display information in your docs does not throw errors.
3+
Kind 2 String is designed to take the data structures output by [extract-react-types](https://www.npmjs.com/package/extract-react-types) and convert them to a (useful) string, as well as performing safe traversal through the output of `extract-react-types` so that trying to display information in your docs does not throw errors.
44

5-
It exposes a convert method which allows you to ensure the data structure resolves to a string. It also exposes its converter object, allowing you to overwrite converters of your choice, if you wish to perform some other action other than the default string converter.
5+
It exposes a `convert` method which allows you to ensure the data structure resolves to a string. It also exposes its `converter` object, allowing you to overwrite converters of your choice, if you wish to perform some other action other than the default string converter.
66

77
Default use-case:
88

@@ -13,6 +13,6 @@ import convert from 'kind2string';
1313
export default () => <div>convert(generatedData)</div>;
1414
```
1515

16-
Also, if you are handling the kinds in a custom way, it is good to pass the final kind to kind2string, to ensure that you always pass a string to your react components.
16+
Also, if you are handling the kinds in a custom way, it is good to pass the final kind to `kind2string`, to ensure that you always pass a string to your react components.
1717

18-
For examples of how to use this, the [@atlaskit/docs](https://www.npmjs.com/package/@atlaskit/docs) is this package. A good pattern on how to implement `kind2string` can be found in the [prettyproptypes](https://bitbucket.org/atlassian/atlaskit-mk-2/src/HEAD/packages/utils/docs/src/Props/PrettyPropType.js?at=master&fileviewer=file-view-default) file.
18+
For examples of how to use this, the [@atlaskit/docs](https://www.npmjs.com/package/@atlaskit/docs) uses this package. A good pattern on how to implement `kind2string` can be found in the [prettyproptypes](https://github.com/atlassian/extract-react-types/tree/master/packages/pretty-proptypes) file.

readme.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
# Extract react types mono repo
22

3-
> One stop shop to document the your react components.
3+
> One stop shop to document your react components.
44
55
Packages:
66

77
1. [extract-react-types](./packages/extract-react-types) _Extract Flow & TypeScript types from React Components_
88
2. [extract-react-types-loader](./packages/extract-react-types-loader) _Webpack loader for extract-react-types_
9-
3. [kind2string](./packages/kind2string) _kind2string is designed to take the data structures outputted by extract-react-types and convert it down to a (useful) string._
10-
4. [pretty-proptypes](./packages/pretty-proptypes) _PrettyPropTypes is designed to display the output of extract-react-types. It is designed to read the output from extract-react-types, and display rich prop information for consumers._
9+
3. [kind2string](./packages/kind2string) _kind2string is designed to take the data structures output by extract-react-types and convert it down to a (useful) string._
10+
4. [pretty-proptypes](./packages/pretty-proptypes) _PrettyPropTypes is designed to display the output of extract-react-types and display rich prop information for consumers._
1111

1212
## Contribute
1313

0 commit comments

Comments
 (0)