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

Improve addon-info README options documentation #1732

Merged
merged 2 commits into from
Aug 25, 2017

Conversation

tenshiemi
Copy link
Contributor

Added more info about options available since it was confusing

Added more info about options available
@codecov
Copy link

codecov bot commented Aug 24, 2017

Codecov Report

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

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1732   +/-   ##
=======================================
  Coverage   21.18%   21.18%           
=======================================
  Files         252      252           
  Lines        5694     5694           
  Branches      679      692   +13     
=======================================
  Hits         1206     1206           
+ Misses       3979     3946   -33     
- Partials      509      542   +33
Impacted Files Coverage Δ
app/react/src/server/utils.js 0% <0%> (-32.15%) ⬇️
lib/ui/src/libs/key_events.js 23.25% <0%> (ø) ⬆️
.../ui/src/modules/ui/components/layout/dimensions.js 15.62% <0%> (ø) ⬆️
addons/info/src/components/PropVal.js 43.15% <0%> (ø) ⬆️
addons/knobs/src/KnobManager.js 32% <0%> (ø) ⬆️
lib/ui/src/modules/api/configs/init_api.js 40.47% <0%> (ø) ⬆️
lib/ui/src/modules/ui/containers/layout.js 12.5% <0%> (ø) ⬆️
.../ui/src/modules/ui/components/left_panel/header.js 28.57% <0%> (ø) ⬆️
addons/info/src/components/markdown/htags.js 30% <0%> (ø) ⬆️
app/react-native/src/preview/story_kind.js 0% <0%> (ø) ⬆️
... and 22 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 5f5dc40...709961d. Read the comment docs.

inline: true,
maxPropsIntoLine: 1,
header: false, // Toggles display of header with component name and description
inline: true, // Displays info inline vs click button to view
Copy link
Member

@usulpro usulpro Aug 24, 2017

Choose a reason for hiding this comment

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

@tenshiemi, thank you for pointing us to this lack of documentation!

There're some more options:
source, propTables, propTablesExclude, styles

Could you also add them if you want? otherwise, we'll do it ourselves

@ndelangen
Copy link
Member

Hi @tenshiemi Sorry about the confusion, but thank you so much for taking the time to make a PR, to improve!

Truly appreciated! Do you want to take a look at @usulpro's comments, that'd be fantastic. If you're stretched on time, that's fine, we can merge as is, and @usulpro will add it, I think.

@usulpro
Copy link
Member

usulpro commented Aug 25, 2017

I was going to do big update of addon-info readme in #1501, but I want to use this PR as a good chance to make it relevant to the current state and possible future updates

So I just add some additional notes

@usulpro usulpro merged commit ed35cf3 into storybookjs:master Aug 25, 2017
@shilman shilman changed the title Update README.md Improve addon-info README options documentation Aug 26, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants