Update story shots docs and fix a typo in the API #1421
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
Generated by 🚫 dangerJS |
Codecov Report
@@ Coverage Diff @@
## master #1421 +/- ##
=======================================
Coverage 14.35% 14.35%
=======================================
Files 201 201
Lines 4612 4612
Branches 622 551 -71
=======================================
Hits 662 662
- Misses 3422 3486 +64
+ Partials 528 464 -64
Continue to review full report at Codecov.
|
ndelangen
added
the
cleanup
ndelangen
approved these changes
Jul 6, 2017
| @@ -56,7 +56,8 @@ export default function testStorySnapshots(options = {}) { | |||
| throw new Error('testStorySnapshots is intended only to be used inside jest'); | |||
| } | |||
|
|
|||
| const suit = options.suit || 'Storyshots'; | |||
| // NOTE: keep `suit` typo for backwards compatibility | |||
| const suite = options.suite || options.suit || 'Storyshots'; | |||
|
|
||
| ```sh | ||
| npm run test-storybook | ||
| npm test |
There was a problem hiding this comment.
@ndelangen i'd bet it started out this way and then the tool changed and the docs got stale
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.
Issue: #1396
What I did
Fixed the documentation -- there is no storyshots binary
Also
suitoption should besuiteHow to test