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

fix(addon-info): Display description when story name matches component #4863

Merged
merged 7 commits into from
Dec 20, 2018

Conversation

misund
Copy link
Contributor

@misund misund commented Nov 26, 2018

Fixes #4860

See #4643
See #4685

What I did

  • Display description from JSDoc when the story name matches the component
  • This matches the behavior in 4.0.8
  • Also retains the behavior from 4.0.9, from when the JSDoc decription is displayed when the story kind matches the component

How to test

  • I added a test for when the story name matches alongside the the test for when the story kind matches

@misund misund force-pushed the fix/addon-info-story-name-match branch from e38123e to 81ca654 Compare November 28, 2018 20:33
@misund
Copy link
Contributor Author

misund commented Dec 3, 2018

@shilman You merged #4685, would you mind having a quick look at this PR as well? They are sort of related.

@misund
Copy link
Contributor Author

misund commented Dec 13, 2018

Any feedback would be appreciated.

@igor-dv
Copy link
Member

igor-dv commented Dec 14, 2018

Tests are failing. Besides that LGTM.

@ndelangen ndelangen self-assigned this Dec 14, 2018
@codecov
Copy link

codecov bot commented Dec 15, 2018

Codecov Report

Merging #4863 into next will increase coverage by <.01%.
The diff coverage is 100%.

Impacted file tree graph

@@            Coverage Diff             @@
##             next    #4863      +/-   ##
==========================================
+ Coverage   35.31%   35.32%   +<.01%     
==========================================
  Files         582      582              
  Lines        7102     7103       +1     
  Branches      950      950              
==========================================
+ Hits         2508     2509       +1     
  Misses       4091     4091              
  Partials      503      503
Impacted Files Coverage Δ
addons/info/src/components/Story.js 88.34% <100%> (+0.11%) ⬆️

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 03c4c0f...670e1ab. Read the comment docs.

@misund
Copy link
Contributor Author

misund commented Dec 15, 2018

Wow, I messed that up real good, didn't I.

@ndelangen
Copy link
Member

Looks like mostly linting errors?

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.

addon-info: story description not displaying since 4.0.9
3 participants