From 66dfd8f0c1fd60822788098ec4fe4ad8e1d49267 Mon Sep 17 00:00:00 2001 From: Brian Ng Date: Wed, 30 Nov 2016 11:19:54 -0600 Subject: [PATCH] Fix some React transform README issues [skip ci] (#4917) --- .../babel-plugin-transform-react-constant-elements/README.md | 4 +--- packages/babel-plugin-transform-react-display-name/README.md | 2 +- .../babel-plugin-transform-react-inline-elements/README.md | 4 +--- packages/babel-plugin-transform-react-jsx-compat/README.md | 2 +- packages/babel-plugin-transform-react-jsx-self/README.md | 4 ++-- packages/babel-plugin-transform-react-jsx-source/README.md | 3 ++- packages/babel-plugin-transform-react-jsx/README.md | 2 +- 7 files changed, 9 insertions(+), 12 deletions(-) diff --git a/packages/babel-plugin-transform-react-constant-elements/README.md b/packages/babel-plugin-transform-react-constant-elements/README.md index 3df20956fa..6a75ab7a4a 100644 --- a/packages/babel-plugin-transform-react-constant-elements/README.md +++ b/packages/babel-plugin-transform-react-constant-elements/README.md @@ -1,8 +1,6 @@ # babel-plugin-transform-react-constant-elements -Hoists element creation to the top level for subtrees that are fully static, which reduces both allocations and calls to `React.createElement`. More importantly, it tells React that the subtree hasn't changed so React can completely skip it when reconciling. - -This transform **should be enabled only in production** (e.g., just before minifying your code) because although it improves runtime performance, it makes warning messages more cryptic. +> Treat React JSX elements as value types and hoist them to the highest scope ## Example diff --git a/packages/babel-plugin-transform-react-display-name/README.md b/packages/babel-plugin-transform-react-display-name/README.md index ed29ac0bfa..9c1e98b05e 100644 --- a/packages/babel-plugin-transform-react-display-name/README.md +++ b/packages/babel-plugin-transform-react-display-name/README.md @@ -1,6 +1,6 @@ # babel-plugin-transform-react-display-name -Add displayName to React.createClass calls +> Add displayName to React.createClass calls ## Installation diff --git a/packages/babel-plugin-transform-react-inline-elements/README.md b/packages/babel-plugin-transform-react-inline-elements/README.md index a69c73b8d4..8893106af4 100644 --- a/packages/babel-plugin-transform-react-inline-elements/README.md +++ b/packages/babel-plugin-transform-react-inline-elements/README.md @@ -1,8 +1,6 @@ # babel-plugin-transform-react-inline-elements -Replaces the `React.createElement` function with one that is more optimized for production: `babelHelpers.jsx`. - -This transform **should be enabled only in production** (e.g., just before minifying your code) because although it improves runtime performance, it makes warning messages more cryptic and skips important checks that happen in development mode, including propTypes. +> Replaces the `React.createElement` function with one that is more optimized for production: `babelHelpers.jsx`. ## Example diff --git a/packages/babel-plugin-transform-react-jsx-compat/README.md b/packages/babel-plugin-transform-react-jsx-compat/README.md index ed9baf918b..73006a4716 100644 --- a/packages/babel-plugin-transform-react-jsx-compat/README.md +++ b/packages/babel-plugin-transform-react-jsx-compat/README.md @@ -1,6 +1,6 @@ # babel-plugin-transform-react-jsx-compat -Turn JSX into React Pre-0.12 function calls +> Turn JSX into React Pre-0.12 function calls ## Example diff --git a/packages/babel-plugin-transform-react-jsx-self/README.md b/packages/babel-plugin-transform-react-jsx-self/README.md index 7873eb2807..d8954dadde 100644 --- a/packages/babel-plugin-transform-react-jsx-self/README.md +++ b/packages/babel-plugin-transform-react-jsx-self/README.md @@ -1,7 +1,6 @@ # babel-plugin-transform-react-jsx-self -Adds `__self` prop to JSX elements, which React will use to generate some runtime warnings. All React users -should enable this transform in dev mode. +> Adds `__self` prop to JSX elements, which React will use to generate some runtime warnings. All React users should enable this transform in dev mode. ## Example @@ -10,6 +9,7 @@ should enable this transform in dev mode. ``` ``` + ### Out ``` diff --git a/packages/babel-plugin-transform-react-jsx-source/README.md b/packages/babel-plugin-transform-react-jsx-source/README.md index 5b48f8f656..f62a79a4e6 100644 --- a/packages/babel-plugin-transform-react-jsx-source/README.md +++ b/packages/babel-plugin-transform-react-jsx-source/README.md @@ -1,6 +1,6 @@ # babel-plugin-transform-react-jsx-source -Adds source file and line number to JSX elements. +> Adds source file and line number to JSX elements. ## Example @@ -9,6 +9,7 @@ Adds source file and line number to JSX elements. ``` ``` + ### Out ``` diff --git a/packages/babel-plugin-transform-react-jsx/README.md b/packages/babel-plugin-transform-react-jsx/README.md index 4f7b2c8d8f..4a7c3ae0fb 100644 --- a/packages/babel-plugin-transform-react-jsx/README.md +++ b/packages/babel-plugin-transform-react-jsx/README.md @@ -1,6 +1,6 @@ # babel-plugin-transform-react-jsx -Turn JSX into React function calls +> Turn JSX into React function calls ## Example