Skip to content

Commit

Permalink
Fix typos (atlassian#68)
Browse files Browse the repository at this point in the history
* Fix typos

* fix typos

update broken link
  • Loading branch information
thiagodebastos authored and Noviny committed Apr 24, 2019
1 parent 287e4b4 commit b93ffae
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
8 changes: 4 additions & 4 deletions packages/kind2string/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Kind 2 String - a parser for extract-react-types

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.
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.

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.
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.

Default use-case:

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

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.
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.

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.
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.
6 changes: 3 additions & 3 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# Extract react types mono repo

> One stop shop to document the your react components.
> One stop shop to document your react components.
Packages:

1. [extract-react-types](./packages/extract-react-types) _Extract Flow & TypeScript types from React Components_
2. [extract-react-types-loader](./packages/extract-react-types-loader) _Webpack loader for extract-react-types_
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._
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._
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._
4. [pretty-proptypes](./packages/pretty-proptypes) _PrettyPropTypes is designed to display the output of extract-react-types and display rich prop information for consumers._

## Contribute

Expand Down

0 comments on commit b93ffae

Please sign in to comment.