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

Document makeDecorators for addons authors #3831

Merged
merged 3 commits into from
Jul 4, 2018

Conversation

tmeasday
Copy link
Member

@tmeasday tmeasday commented Jul 4, 2018

Issue:

We added a makeDecorators API and use it everywhere but it is not documented.

What I did

Added a allowDeprecatedUsage (defaults to false) option to makeDecorator and set it to true for our addons.

Updated the writing addons documentation to reflect the above.

How to test

Added tests for the API change. Please read the docs.

@tmeasday
Copy link
Member Author

tmeasday commented Jul 4, 2018

Hey! Looks like the tests actually saved me here

@tmeasday tmeasday requested a review from saponifi3d as a code owner July 4, 2018 10:48
@codecov
Copy link

codecov bot commented Jul 4, 2018

Codecov Report

Merging #3831 into master will increase coverage by 0.02%.
The diff coverage is 100%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #3831      +/-   ##
==========================================
+ Coverage   41.35%   41.38%   +0.02%     
==========================================
  Files         455      455              
  Lines        5184     5186       +2     
  Branches      900      901       +1     
==========================================
+ Hits         2144     2146       +2     
  Misses       2496     2496              
  Partials      544      544
Impacted Files Coverage Δ
addons/backgrounds/src/index.js 0% <ø> (ø) ⬆️
addons/viewport/src/preview/withViewport.js 28.57% <ø> (ø) ⬆️
addons/info/src/index.js 79.16% <ø> (ø) ⬆️
addons/notes/src/index.js 83.33% <ø> (ø) ⬆️
addons/knobs/src/index.js 0% <ø> (ø) ⬆️
lib/addons/src/make-decorator.js 94.44% <100%> (+0.69%) ⬆️

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 759d741...96667b5. Read the comment docs.

@Hypnosphi Hypnosphi merged commit dbf243d into master Jul 4, 2018
@Hypnosphi Hypnosphi deleted the tmeasday/document-parameters-for-addons branch July 4, 2018 14:27
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