CORRECT readme for knobs && change comment on deprecating requiring @…

…storybook/addon-knobs directly
storybookjs · Sep 11, 2017 · ca11103 · ca11103
1 parent 5e74ef8
commit ca11103
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 5 deletions.
diff --git a/addons/knobs/README.md b/addons/knobs/README.md
@@ -256,9 +256,9 @@ Usage:
 ```js
 import { storiesOf } from '@storybook/react';
 
-const stories = storiesOf('')
+const stories = storiesOf('Storybook Knobs', module);
 
-story.addDecorator(withKnobsOptions({
+stories.addDecorator(withKnobsOptions({
   debounce: { wait: number, leading: boolean}, // Same as lodash debounce.
   timestamps: true // Doesn't emit events while user is typing.
 }));

diff --git a/addons/knobs/src/index.js b/addons/knobs/src/index.js
@@ -14,9 +14,8 @@ deprecate(
   'Using @storybook/addon-knobs directly is discouraged, please use @storybook/addon-knobs/{{framework}}'
 );
 
-// "Higher order component" / wrapper style API
-// In 3.3, this will become `withKnobs`, once our decorator API supports it.
-// See https://github.com/storybooks/storybook/pull/1527
+// generic higher-order component decorator for all platforms - usage is discouraged
+// This file Should be removed with 4.0 release
 function wrapperKnobs(options) {
   const channel = addons.getChannel();
   manager.setChannel(channel);