Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add short description to addon-options readme #1566

Merged
merged 1 commit into from
Aug 1, 2017
Merged

Conversation

danielduan
Copy link
Member

Issue: These options are not clear on what exactly they do.

What I did

added a short description. any opinions on whether the options listed should show our defaults?

How to test

showSearchBox: false, // display search box to filter stories
downPanelInRight: false, // show horizontal addons panel as a vertical panel on the right
sortStoriesByKind: false, // sorts stories
hierarchySeparator: /\//, // regex for finding the hierarchy separator
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

or null to disable?

Copy link
Member

@shilman shilman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great addition!

@codecov
Copy link

codecov bot commented Aug 1, 2017

Codecov Report

Merging #1566 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1566   +/-   ##
=======================================
  Coverage   20.43%   20.43%           
=======================================
  Files         241      241           
  Lines        5250     5250           
  Branches      647      650    +3     
=======================================
  Hits         1073     1073           
+ Misses       3697     3685   -12     
- Partials      480      492   +12
Impacted Files Coverage Δ
addons/knobs/src/components/types/Boolean.js 11.62% <0%> (ø) ⬆️
addons/info/src/components/Props.js 37.2% <0%> (ø) ⬆️
addons/storyshots/src/storybook-channel-mock.js 0% <0%> (ø) ⬆️
addons/knobs/src/KnobManager.js 35.41% <0%> (ø) ⬆️
addons/info/src/components/markdown/code.js 24.13% <0%> (ø) ⬆️
addons/knobs/src/components/types/Select.js 7.81% <0%> (ø) ⬆️
addons/info/src/components/Node.js 38.88% <0%> (ø) ⬆️
addons/info/src/components/markdown/htags.js 30% <0%> (ø) ⬆️
lib/ui/src/modules/api/configs/init_api.js 40.47% <0%> (ø) ⬆️
app/react-native/src/bin/storybook-start.js 0% <0%> (ø) ⬆️
... and 16 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 56919e4...5e23c37. Read the comment docs.

@danielduan danielduan merged commit d7f6b56 into master Aug 1, 2017
@danielduan danielduan deleted the options-readme branch August 1, 2017 17:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants