Attempt to make propTablesExclude usage clearer #2568
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
See issue storybookjs#2266, specifically storybookjs#2266 (comment) for discussion.
Codecov Report
@@ Coverage Diff @@
## master #2568 +/- ##
=======================================
Coverage 32.68% 32.68%
=======================================
Files 398 398
Lines 8838 8838
Branches 943 947 +4
=======================================
Hits 2889 2889
- Misses 5293 5295 +2
+ Partials 656 654 -2
Continue to review full report at Codecov.
|
Hypnosphi
requested changes
Dec 26, 2017
addons/info/README.md
Outdated
| @@ -130,7 +130,7 @@ setDefaults({ | |||
| inline: true, // Displays info inline vs click button to view | |||
| source: true, // Displays the source of story Component | |||
| propTables: [/* Components used in story */], // displays Prop Tables with this components | |||
| propTablesExclude: [], // Exclude Components from being shown in Prop Tables section | |||
| propTablesExclude: [], // Exclude Components from being shown in Prop Tables section. Pass the imported component names as values to the array. | |||
There was a problem hiding this comment.
Component name is a string, but here the component itself (class or stateless function) should be passed
|
Would it make more sense to say "Pass the imported component class or function to the array." |
|
"Accepts an array of component classes or functions". The component may be defined in the same file, so mentioning imports may be confusing. |
Changed to agreed upon instructions for propTablesExclude to provide clearer documentation.
Hypnosphi
approved these changes
Dec 27, 2017
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
See issue #2266, specifically #2266 (comment) for discussion.
Issue: #2266
What I did
Added text to documentation make propTablesExclude clearer
How to test
No changes to code made.
Is this testable with jest or storyshots?
No
Does this need a new example in the kitchen sink apps?
No but would maybe be a good idea.
Does this need an update to the documentation?
This is an update.
If your answer is yes to any of these, please make sure to include it in your PR.