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

Update Icon comments for formatting in docs mode #30

Merged
merged 1 commit into from
Jun 26, 2019

Conversation

kylesuss
Copy link
Contributor

@kylesuss kylesuss commented Jun 26, 2019

Hey @jsomsanith , we have been trying to play around w/ the new docs mode features for Storybook (they are currently in alpha) and I noticed that the comment you wrote about the Icon is getting pulled into the docs:

Screen Shot 2019-06-26 at 9 19 30 AM

w/ just a few lil tweaks in this PR, I changed the formatting to this:

Screen Shot 2019-06-26 at 9 19 40 AM

What do you think? Wanted to share so you can see how easy it is to get the docs over into Storybook for the accessibility help that you are providing. Maybe you already knew? 😄

It works with propTypes as well:

Icon.propTypes = {
  /**
   Explain the icon propType in a comment like this!
  */
  icon: PropTypes.string.isRequired,
};

@jsomsanith
Copy link
Contributor

Hello @kylesuss. Yes @domyen helped me to play with docs but thanks for the tip anyway, that’s a cool example and formatting advice for docs !

@kylesuss
Copy link
Contributor Author

Thanks @jsomsanith . I am really just learning how to use docs mode myself and was excited about how easy it was to format that comment.

Appreciate your help!

@kylesuss kylesuss merged commit 1261911 into master Jun 26, 2019
@kylesuss kylesuss deleted the update-icon-docs branch June 26, 2019 15:44
@kylesuss
Copy link
Contributor Author

🚀 PR was released in v0.0.28 🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants