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

Deprecate confusing option names #1692

Merged
merged 16 commits into from
Aug 31, 2017
Merged

Deprecate confusing option names #1692

merged 16 commits into from
Aug 31, 2017

Conversation

Hypnosphi
Copy link
Member

@Hypnosphi Hypnosphi commented Aug 20, 2017

"Left Panel" => "Stories Panel"
"Down Panel" => "Addon Panel"

Old option names stay fully supported for now, but produce a deprecation warning in development

I'll update the addon-options docs as soon as it's published

How to test:

@codecov
Copy link

codecov bot commented Aug 20, 2017

Codecov Report

Merging #1692 into release/3.3 will increase coverage by 0.11%.
The diff coverage is 50.79%.

Impacted file tree graph

@@               Coverage Diff               @@
##           release/3.3    #1692      +/-   ##
===============================================
+ Coverage        23.01%   23.13%   +0.11%     
===============================================
  Files              253      253              
  Lines             5731     5745      +14     
  Branches           682      693      +11     
===============================================
+ Hits              1319     1329      +10     
+ Misses            3921     3918       -3     
- Partials           491      498       +7
Impacted Files Coverage Δ
lib/ui/src/modules/ui/components/shortcuts_help.js 40.9% <ø> (ø) ⬆️
...nents/stories_panel/stories_tree/tree_node_type.js 0% <ø> (ø)
...modules/ui/components/stories_panel/text_filter.js 30.98% <ø> (ø)
.../ui/components/stories_panel/stories_tree/index.js 100% <ø> (ø)
...tories_panel/stories_tree/tree_decorators_utils.js 45.23% <ø> (ø)
...omponents/stories_panel/stories_tree/tree_style.js 25% <ø> (ø)
lib/ui/src/modules/ui/containers/stories_panel.js 25.71% <ø> (ø)
lib/ui/src/modules/ui/containers/addon_panel.js 23.52% <ø> (ø)
...ents/stories_panel/stories_tree/tree_decorators.js 34.37% <ø> (ø)
lib/ui/src/modules/ui/actions/ui.js 30% <0%> (ø) ⬆️
... and 38 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 12cd9c3...26307a0. Read the comment docs.

Copy link
Member

@igor-dv igor-dv left a comment

Choose a reason for hiding this comment

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

LGTM. (Let's not merge until #1693, please)

DOWN_PANEL: 2,
LEFT_PANEL: 3,
ADDON_PANEL: 2,
NAVIGATION_PANEL: 3,
Copy link
Member

Choose a reason for hiding this comment

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

Why everywhere it's called "Stories Panel" but here is "Navigation Panel"?

Copy link
Member Author

Choose a reason for hiding this comment

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

My bad, skipped when refactoring

@usulpro
Copy link
Member

usulpro commented Aug 20, 2017

Great! 👍
This change is something that we really need to have done!

But I prefer to have a strong "How to test" section and maybe better to merge it right before the next minor releasing

@Hypnosphi
Copy link
Member Author

a strong "How to test" section

I've made one, but both cases are covered by added tests

@@ -2,14 +2,14 @@ import keycode from 'keycode';

export const features = {
FULLSCREEN: 1,
Copy link
Member

Choose a reason for hiding this comment

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

Maybe it's a good time to also switch from numbers to literals here, what do you think?

Copy link
Member Author

Choose a reason for hiding this comment

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

Nice idea

Copy link
Member

@danielduan danielduan left a comment

Choose a reason for hiding this comment

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

Don't forget to update the readme file too. The docs might need an update as well.

https://github.com/storybooks/storybook/blob/master/addons/options/README.md

@Hypnosphi
Copy link
Member Author

Hypnosphi commented Aug 20, 2017

I'll update the addon-options docs as soon as it's published

I find it weird to see docs for options that are not yet actually available

@Hypnosphi Hypnosphi changed the base branch from master to release/3.3 August 30, 2017 22:49
…ft-down

# Conflicts:
#	lib/ui/src/modules/ui/components/layout/index.test.js
@Hypnosphi
Copy link
Member Author

Hypnosphi commented Aug 30, 2017

@danielduan I've changed base fork to release/3.3, this made it possible to update README right now

@Hypnosphi Hypnosphi merged commit 184dae3 into release/3.3 Aug 31, 2017
@Hypnosphi Hypnosphi deleted the deprecate-left-down branch August 31, 2017 11:15
@shilman shilman mentioned this pull request Aug 31, 2017
@ndelangen ndelangen added maintenance User-facing maintenance tasks and removed feature request labels Sep 1, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
addon: options maintenance User-facing maintenance tasks ui
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants