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

Add/block types list component readme #25066

Conversation

JustinyAhin
Copy link
Member

Description

Added documentation for the block types list component (see #22891)

How has this been tested?

N/A, documentation only

Types of changes

Documentation

Checklist:

  • [n/a] My code is tested.
  • [n/a] My code follows the WordPress code style.
  • [n/a] My code follows the accessibility standards.
  • [n/a] 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.

Copy link
Member

@mkaz mkaz left a comment

Choose a reason for hiding this comment

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

This looks fine. If you want you can add clarity that the items is an Array of blocks.
Something like Type: Array<Block>

Unfortunately the types aren't clearly defined everywhere, but the goal is to get all functions using typescript jsdoc to define, that makes all this easier. Here's a reference on defining type structures: https://www.typescriptlang.org/docs/handbook/jsdoc-supported-types.html

@JustinyAhin JustinyAhin force-pushed the add/block-types-list-component-readme branch from fa771d2 to 0d34bc6 Compare September 9, 2020 17:49
@JustinyAhin JustinyAhin merged commit 14edc2d into WordPress:master Sep 9, 2020
@github-actions github-actions bot added this to the Gutenberg 9.0 milestone Sep 9, 2020
@JustinyAhin JustinyAhin deleted the add/block-types-list-component-readme branch September 14, 2020 05:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Type] Developer Documentation Documentation for developers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants