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

Components: Improve docs for the SpaceInput type #42376

Merged
merged 2 commits into from
Jul 13, 2022
Merged

Conversation

mirka
Copy link
Member

@mirka mirka commented Jul 12, 2022

Closes #41882

What?

Improves the documentation for the SpaceInput type.

Why?

Currently, one cannot correctly understand what SpaceInput is unless they read the doc comment for the space() utility function itself.

How?

  • Update the doc comment for the SpaceInput type so that it is accurate.
  • Add a short note to the relevant props in Divider and Flex.
  • Update the doc comment for Spacer so it includes the fact that you can use a standard CSS string. (Not adding notes to all the props here because there are too many, and they are the main focus of the Spacer component 😄)

Testing Instructions

  1. npm run storybook:dev
  2. Check docs for Divider, Flex, and Spacer.

@mirka mirka added [Type] Developer Documentation Documentation for developers [Package] Components /packages/components Storybook Storybook and its stories for components labels Jul 12, 2022
@mirka mirka requested a review from ajitbohra as a code owner July 12, 2022 17:01
@mirka mirka self-assigned this Jul 12, 2022
@mirka mirka requested review from walbo and ciampo July 12, 2022 17:13
Copy link
Member

@walbo walbo left a comment

Choose a reason for hiding this comment

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

LGTM 👍

@mirka mirka force-pushed the enhance/space-input-desc branch from 67de636 to 402f1e9 Compare July 13, 2022 18:56
@mirka mirka merged commit 72062fc into trunk Jul 13, 2022
@mirka mirka deleted the enhance/space-input-desc branch July 13, 2022 21:39
@github-actions github-actions bot added this to the Gutenberg 13.8 milestone Jul 13, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Package] Components /packages/components Storybook Storybook and its stories for components [Type] Developer Documentation Documentation for developers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Components: Reassess usage of the SpaceInput type
2 participants