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

UnitControl: Fixed documentation for units attribute #31901

Merged

Conversation

hsmio
Copy link
Contributor

@hsmio hsmio commented May 17, 2021

Description

This PR fixes typos and omissions in documentation and Storybook to properly document the property units of the UnitControl component.

Problem solved: When looking at storybook & docs, it was unclear if/how we could define the units available in the component <UnitControl/>.

How has this been tested?

I created a demo here to make sure the syntax is correct: https://codesandbox.io/s/beautiful-burnell-3d4gm?file=/src/App.js and ran npm run storybook:dev to test the Storybook result (see screenshots).

Screenshots

See it in action: https://user-images.githubusercontent.com/5040227/118523628-3711df80-b735-11eb-9623-3d698a7137f9.mp4

gutenberg-unitcontrol-units

Types of changes

Documentation fixes (non-breaking)

Checklist:

  • My code is tested.
  • My code follows the WordPress code style.
  • My code follows the accessibility standards.
  • I've tested my changes with keyboard and screen readers.
  • My code has proper inline documentation.
  • I've included developer documentation if appropriate.
  • I've updated all React Native files affected by any refactorings/renamings in this PR (please manually search all *.native.js files for terms that need renaming or removal).

@github-actions github-actions bot added the First-time Contributor Pull request opened by a first-time contributor to Gutenberg repository label May 17, 2021
@github-actions
Copy link

👋 Thanks for your first Pull Request and for helping build the future of Gutenberg and WordPress, @hsmio! In case you missed it, we'd love to have you join us in our Slack community, where we hold regularly weekly meetings open to anyone to coordinate with each other.

If you want to learn more about WordPress development in general, check out the Core Handbook full of helpful information.

Copy link
Member

@jorgefilipecosta jorgefilipecosta left a comment

Choose a reason for hiding this comment

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

LGTM 👍 Thank you for this enhancement!

@jorgefilipecosta jorgefilipecosta merged commit b61a2d8 into WordPress:trunk Jun 2, 2021
@github-actions
Copy link

github-actions bot commented Jun 2, 2021

Congratulations on your first merged pull request, @hsmio! We'd like to credit you for your contribution in the post announcing the next WordPress release, but we can't find a WordPress.org profile associated with your GitHub account. When you have a moment, visit the following URL and click "link your GitHub account" under "GitHub Username" to link your accounts:

https://profiles.wordpress.org/me/profile/edit/

And if you don't have a WordPress.org account, you can create one on this page:

https://login.wordpress.org/register

Kudos!

@github-actions github-actions bot added this to the Gutenberg 10.8 milestone Jun 2, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
First-time Contributor Pull request opened by a first-time contributor to Gutenberg repository
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants