Skip to content

Commit

Permalink
Adds better descriptions for all blocks (#6624)
Browse files Browse the repository at this point in the history
Iterates on descriptions and audits them all as a result.

Props @michelleweber. Fixes #6623
  • Loading branch information
Tammie Lister authored May 8, 2018
1 parent 94e13e3 commit 9d4fd10
Show file tree
Hide file tree
Showing 26 changed files with 26 additions and 26 deletions.
2 changes: 1 addition & 1 deletion core-blocks/audio/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ export const name = 'core/audio';
export const settings = {
title: __( 'Audio' ),

description: __( 'The Audio block allows you to embed audio files and play them back using a simple player.' ),
description: __( 'Embed an audio file and a simple audio player.' ),

icon: 'format-audio',

Expand Down
2 changes: 1 addition & 1 deletion core-blocks/button/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ const colorsMigration = ( attributes ) => {
export const settings = {
title: __( 'Button' ),

description: __( 'A nice little button. Call something out with it.' ),
description: __( 'Want visitors to click to subscribe, buy, or read more? Get their attention with a button.' ),

icon: 'button',

Expand Down
2 changes: 1 addition & 1 deletion core-blocks/categories/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ export const name = 'core/categories';
export const settings = {
title: __( 'Categories' ),

description: __( 'Shows a list of your site\'s categories.' ),
description: __( 'Display a list of all your site\'s categories.' ),

icon: 'list-view',

Expand Down
2 changes: 1 addition & 1 deletion core-blocks/code/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ export const name = 'core/code';
export const settings = {
title: __( 'Code' ),

description: __( 'The code block maintains spaces and tabs, great for showing code snippets.' ),
description: __( 'Add text that respects your spacing and tabs -- perfect for displaying code.' ),

icon: 'editor-code',

Expand Down
2 changes: 1 addition & 1 deletion core-blocks/columns/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ export const settings = {
},
},

description: __( 'A multi-column layout of content.' ),
description: __( 'Add a block that displays content in multiple columns, then add whatever content blocks you\'d like.' ),

supports: {
align: [ 'wide', 'full' ],
Expand Down
2 changes: 1 addition & 1 deletion core-blocks/cover-image/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ export const name = 'core/cover-image';
export const settings = {
title: __( 'Cover Image' ),

description: __( 'Cover Image is a bold image block with an optional title.' ),
description: __( 'Add a full-width image, and layer text over it -- great for headers.' ),

icon: 'cover-image',

Expand Down
2 changes: 1 addition & 1 deletion core-blocks/embed/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ const HOSTS_NO_PREVIEWS = [ 'facebook.com' ];

function getEmbedBlockSettings( { title, description, icon, category = 'embed', transforms, keywords = [] } ) {
// translators: %s: Name of service (e.g. VideoPress, YouTube)
const blockDescription = description || sprintf( __( 'Paste URLs from %s to embed the content in this block' ), title );
const blockDescription = description || sprintf( __( 'Add a block that displays content pulled from other sites, like Twitter, Instagram or YouTube.' ), title );
return {
title,
description: blockDescription,
Expand Down
2 changes: 1 addition & 1 deletion core-blocks/freeform/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ export const name = 'core/freeform';
export const settings = {
title: __( 'Classic' ),

description: __( 'The classic editor, in block form.' ),
description: __( 'It\'s the classic WordPress editor and it\'s block! Drop the editor right in.' ),

icon: 'editor-kitchensink',

Expand Down
2 changes: 1 addition & 1 deletion core-blocks/gallery/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ export const name = 'core/gallery';

export const settings = {
title: __( 'Gallery' ),
description: __( 'Image galleries are a great way to share groups of pictures on your site.' ),
description: __( 'Display multiple images in an elegantly organized tiled layout.' ),
icon: 'format-gallery',
category: 'common',
keywords: [ __( 'images' ), __( 'photos' ) ],
Expand Down
2 changes: 1 addition & 1 deletion core-blocks/heading/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ export const name = 'core/heading';
export const settings = {
title: __( 'Heading' ),

description: __( 'Search engines use the headings to index the structure and content of your web pages.' ),
description: __( 'Insert a headline above your post or page content.' ),

icon: 'heading',

Expand Down
2 changes: 1 addition & 1 deletion core-blocks/html/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ export const name = 'core/html';
export const settings = {
title: __( 'Custom HTML' ),

description: __( 'Add custom HTML code and preview it right here in the editor.' ),
description: __( 'Add your own HTML (and view it right here as you edit!).' ),

icon: 'html',

Expand Down
2 changes: 1 addition & 1 deletion core-blocks/image/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ const schema = {
export const settings = {
title: __( 'Image' ),

description: __( 'Worth a thousand words.' ),
description: __( 'They\'re worth 1,000 words! Insert a single image.' ),

icon: 'format-image',

Expand Down
2 changes: 1 addition & 1 deletion core-blocks/latest-posts/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ export const name = 'core/latest-posts';
export const settings = {
title: __( 'Latest Posts' ),

description: __( 'Shows a list of your site\'s most recent posts.' ),
description: __( 'Display a list of your most recent posts.' ),

icon: 'list-view',

Expand Down
2 changes: 1 addition & 1 deletion core-blocks/list/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ export const name = 'core/list';

export const settings = {
title: __( 'List' ),
description: __( 'List. Numbered or bulleted.' ),
description: __( 'Numbers, bullets, up to you. Add a list of items.' ),
icon: 'editor-ul',
category: 'common',
keywords: [ __( 'bullet list' ), __( 'ordered list' ), __( 'numbered list' ) ],
Expand Down
2 changes: 1 addition & 1 deletion core-blocks/more/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ export const name = 'core/more';
export const settings = {
title: __( 'More' ),

description: __( '"More" allows you to break your post into a part shown on index pages, and the subsequent after clicking a "Read More" link.' ),
description: __( 'Want to show only part of this post on your blog\'s home page? Insert a "More" block where you want the split.' ),

icon: 'editor-insertmore',

Expand Down
2 changes: 1 addition & 1 deletion core-blocks/paragraph/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -313,7 +313,7 @@ export const name = 'core/paragraph';
export const settings = {
title: __( 'Paragraph' ),

description: __( 'This is a simple text only block for adding a single paragraph of content.' ),
description: __( 'Add some basic text.' ),

icon: 'editor-paragraph',

Expand Down
2 changes: 1 addition & 1 deletion core-blocks/preformatted/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ export const name = 'core/preformatted';
export const settings = {
title: __( 'Preformatted' ),

description: __( 'Preformatted text keeps your spaces, tabs and linebreaks as they are.' ),
description: __( 'Add text that respects your spacing and tabs, and also allows styling.' ),

icon: 'text',

Expand Down
2 changes: 1 addition & 1 deletion core-blocks/pullquote/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ export const settings = {

title: __( 'Pullquote' ),

description: __( 'A pullquote is a brief, attention-catching quotation taken from the main text of an article and used as a subheading or graphic feature.' ),
description: __( 'Highlight a quote from your post or page by displaying it as a graphic element.' ),

icon: 'format-quote',

Expand Down
2 changes: 1 addition & 1 deletion core-blocks/quote/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ export const name = 'core/quote';

export const settings = {
title: __( 'Quote' ),
description: __( 'Quote. In quoting others, we cite ourselves. (Julio Cortázar)' ),
description: __( 'Maybe someone else said it better -- add some quoted text.' ),
icon: 'format-quote',
category: 'common',

Expand Down
2 changes: 1 addition & 1 deletion core-blocks/separator/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ export const name = 'core/separator';
export const settings = {
title: __( 'Separator' ),

description: __( 'Use the separator to indicate a thematic change in the content.' ),
description: __( 'Insert a horizontal line where you want to create a break between ideas.' ),

icon: 'minus',

Expand Down
2 changes: 1 addition & 1 deletion core-blocks/shortcode/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ export const name = 'core/shortcode';
export const settings = {
title: __( 'Shortcode' ),

description: __( 'A shortcode is a WordPress-specific code snippet that is written between square brackets as [shortcode]. ' ),
description: __( 'Add a shortcode -- a WordPress-specific snippet of code written between square brackets.' ),

icon: 'shortcode',

Expand Down
2 changes: 1 addition & 1 deletion core-blocks/subhead/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ export const name = 'core/subhead';
export const settings = {
title: __( 'Subhead' ),

description: __( 'Explanatory text under the main heading of an article.' ),
description: __( 'What\'s a subhead? Smaller than a headline, bigger than basic text.' ),

icon: 'text',

Expand Down
2 changes: 1 addition & 1 deletion core-blocks/table/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ export const name = 'core/table';

export const settings = {
title: __( 'Table' ),
description: __( 'Tables. Best used for tabular data.' ),
description: __( 'Insert a table -- perfect for sharing charts and data.' ),
icon: 'editor-table',
category: 'formatting',

Expand Down
2 changes: 1 addition & 1 deletion core-blocks/text-columns/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ export const name = 'core/text-columns';
export const settings = {
title: __( 'Text Columns' ),

description: __( 'Add text across columns. This block is experimental' ),
description: __( 'Add text, and display it in two or more columns. Like a newspaper! This block is experimental.' ),

icon: 'columns',

Expand Down
2 changes: 1 addition & 1 deletion core-blocks/verse/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ export const name = 'core/verse';
export const settings = {
title: __( 'Verse' ),

description: __( 'Write poetry and other literary expressions honoring all spaces and line-breaks.' ),
description: __( 'A block for haiku? Why not? Blocks for all the things! (See what we did here?)' ),

icon: 'edit',

Expand Down
2 changes: 1 addition & 1 deletion core-blocks/video/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ export const name = 'core/video';
export const settings = {
title: __( 'Video' ),

description: __( 'The Video block allows you to embed video files and play them back using a simple player.' ),
description: __( 'Embed an video file and a simple video player.' ),

icon: 'format-video',

Expand Down

0 comments on commit 9d4fd10

Please sign in to comment.