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.

Sign up for GitHub

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

Jump to bottom

Added missing option documentation #6195

Merged
merged 2 commits into from
Mar 21, 2019
Merged

Added missing option documentation #6195

merged 2 commits into from
Mar 21, 2019

Conversation

mortal94
Copy link
Contributor

@mortal94 mortal94 commented Mar 20, 2019 •
edited
Loading

What I did

isToolshown was missing from documentation so i've added it.
It allows to control if to show or hide the toolbar above the story.

@mortal94
Added missing option
c99288d 
isToolshown was missing from documentation. It allows to control if to show or hide the toolbar above the story.
@mortal94 mortal94 changed the title Added missing option Added missing option documentation Mar 20, 2019
wuweiweiwu
wuweiweiwu previously approved these changes Mar 20, 2019
View reviewed changes
shilman
shilman requested changes Mar 20, 2019
View reviewed changes
Copy link
Member

@shilman shilman left a comment

Choose a reason for hiding this comment

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

Thanks for this! I didn't know about this option.

However, addon-options is deprecated as it says at the top of the file, so changes to the documentation should be added to docs/src/pages/configurations/options-parameter/index.md instead.

Also, would you mind updating MIGRATION.md with the new option as well?

@shilman shilman added this to the 5.0.x milestone Mar 20, 2019
@mortal94
Copy link
Contributor Author

Sure!

@wuweiweiwu
Copy link
Member

Oh I didn't realize that options was being deprecated. Excuse my oversight

@wuweiweiwu wuweiweiwu dismissed their stale review March 20, 2019 21:51

addon-options is being deprecated

@mortal94
Added missing isToolshown documentation
1cf2e33 
- MIGRATION.md
- Options Parameters documentation
@codecov
Copy link

codecov bot commented Mar 20, 2019 •
edited
Loading

Codecov Report

Merging #6195 into next will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             next    #6195   +/-   ##
=======================================
  Coverage   38.13%   38.13%           
=======================================
  Files         645      645           
  Lines        9642     9642           
  Branches      354      354           
=======================================
  Hits         3677     3677           
  Misses       5910     5910           
  Partials       55       55

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 2549b16...1cf2e33. Read the comment docs.

1 similar comment
@codecov
Copy link

codecov bot commented Mar 20, 2019

Codecov Report

Merging #6195 into next will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             next    #6195   +/-   ##
=======================================
  Coverage   38.13%   38.13%           
=======================================
  Files         645      645           
  Lines        9642     9642           
  Branches      354      354           
=======================================
  Hits         3677     3677           
  Misses       5910     5910           
  Partials       55       55

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 2549b16...1cf2e33. Read the comment docs.

@shilman shilman added the patch:yes Bugfix & documentation PR that need to be picked to main branch label Mar 21, 2019
@shilman
Copy link
Member

shilman commented Mar 21, 2019

Thanks for the fix @mortal94

@shilman shilman merged commit 5c26470 into storybookjs:next Mar 21, 2019
@mortal94 mortal94 deleted the patch-3 branch March 21, 2019 09:34
@shilman shilman added the patch:done Patch/release PRs already cherry-picked to main/release branch label Mar 23, 2019
shilman added a commit that referenced this pull request Mar 23, 2019
@shilman
Merge pull request #6195 from mortal94/patch-3
48aac8a 
Added missing option documentation
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@shilman shilman shilman approved these changes

@wuweiweiwu wuweiweiwu wuweiweiwu left review comments

@danielduan danielduan Awaiting requested review from danielduan

@usulpro usulpro Awaiting requested review from usulpro

@Hypnosphi Hypnosphi Awaiting requested review from Hypnosphi

@ndelangen ndelangen Awaiting requested review from ndelangen

Assignees
No one assigned
Labels
documentation patch:done Patch/release PRs already cherry-picked to main/release branch patch:yes Bugfix & documentation PR that need to be picked to main branch
Projects
None yet
Milestone
5.0.x
Development

Successfully merging this pull request may close these issues.
3 participants
@mortal94 @wuweiweiwu @shilman