Skip to content

Commit

Permalink
Update design docs to fix typos and linebreaks. (#11838)
Browse files Browse the repository at this point in the history
This is a tiny PR to fix a few typos and linebreaks so the Do's and Dont's are on separate lines.
  • Loading branch information
jasmussen authored Nov 14, 2018
1 parent 3c8eb8e commit 64ba2f9
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion docs/design/block-design.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,12 @@ A block should have a straightforward, short name so users can easily find it in
Blocks should have an identifying icon, ideally using a single color. Try to avoid using the same icon used by an existing block. The core block icons are based on [Material Design Icons](https://material.io/tools/icons/). Look to that icon set, or to [Dashicons](https://developer.wordpress.org/resource/dashicons/) for style inspiration.

![A screenshot of the Block Library with concise block names](https://raw.githubusercontent.com/WordPress/gutenberg/master/docs/design/blocks-do.png)

**Do:**
Use conise block names.
Use concise block names.

![A screenshot of the Block Library with long, multi-line block names](https://raw.githubusercontent.com/WordPress/gutenberg/master/docs/design/blocks-dont.png)

**Don't:**
Avoid long, multi-line block names.

Expand All @@ -40,10 +42,12 @@ Avoid long, multi-line block names.
Every block should include a description in the “Block” tab of the Settings sidebar. This description should explain your block's function clearly. Keep it to a single sentence.

![A screenshot of a short block description](https://raw.githubusercontent.com/WordPress/gutenberg/master/docs/design/block-descriptions-do.png)

**Do:**
Use a short, simple, block description.

![A screenshot of a long block description that includes branding](https://raw.githubusercontent.com/WordPress/gutenberg/master/docs/design/block-descriptions-dont.png)

**Don't:**
Avoid long descriptions and branding.

Expand Down

0 comments on commit 64ba2f9

Please sign in to comment.