Docs: Run Prettier after updating API in documentation (#33498)

WordPress · Jul 19, 2021 · 626f233 · 626f233
1 parent ceaa2da
commit 626f233
Show file tree

Hide file tree

Showing 45 changed files with 350 additions and 368 deletions.
diff --git a/bin/api-docs/update-api-docs.js b/bin/api-docs/update-api-docs.js
@@ -232,6 +232,9 @@ glob.stream( [
 					{ shell: true }
 				);
 			}
+			await execa( 'npm', [ 'run', 'format', output ], {
+				shell: true,
+			} );
 		} catch ( error ) {
 			console.error( error );
 			process.exit( 1 );

diff --git a/docs/reference-guides/data/data-core-annotations.md b/docs/reference-guides/data/data-core-annotations.md
@@ -16,5 +16,4 @@ Nothing to document.
 
 Nothing to document.
 
-
 <!-- END TOKEN(Autogenerated actions|../../../packages/annotations/src/store/actions.js) -->
diff --git a/docs/reference-guides/data/data-core-block-editor.md b/docs/reference-guides/data/data-core-block-editor.md
@@ -705,7 +705,7 @@ Returns the defined block template
 
 _Parameters_
 
--   _state_ `boolean`: 
+-   _state_ `boolean`:
 
 _Returns_
 
@@ -1027,7 +1027,7 @@ Returns whether the blocks matches the template or not.
 
 _Parameters_
 
--   _state_ `boolean`: 
+-   _state_ `boolean`:
 
 _Returns_
 
@@ -1067,8 +1067,8 @@ Generator that triggers an action used to duplicate a list of blocks.
 
 _Parameters_
 
--   _clientIds_ `string[]`: 
--   _updateSelection_ `boolean`: 
+-   _clientIds_ `string[]`:
+-   _updateSelection_ `boolean`:
 
 ### enterFormattedText
 
@@ -1109,15 +1109,15 @@ Generator used to insert an empty block before a given block.
 
 _Parameters_
 
--   _clientId_ `string`: 
+-   _clientId_ `string`:
 
 ### insertBeforeBlock
 
 Generator used to insert an empty block after a given block.
 
 _Parameters_
 
--   _clientId_ `string`: 
+-   _clientId_ `string`:
 
 ### insertBlock
 
@@ -1146,7 +1146,7 @@ _Parameters_
 -   _blocks_ `Object[]`: Block objects to insert.
 -   _index_ `?number`: Index at which block should be inserted.
 -   _rootClientId_ `?string`: Optional root client ID of block list on which to insert.
--   _updateSelection_ `?boolean`: If true block selection will be updated.  If false, block selection will not change. Defaults to true.
+-   _updateSelection_ `?boolean`: If true block selection will be updated. If false, block selection will not change. Defaults to true.
 -   _initialPosition_ `0|-1|null`: Initial focus position. Setting it to null prevent focusing the inserted block.
 -   _meta_ `?Object`: Optional Meta values to be passed to the action object.
 
@@ -1586,5 +1586,4 @@ _Parameters_
 
 -   _blocks_ `Array`: Array of blocks.
 
-
 <!-- END TOKEN(Autogenerated actions|../../../packages/block-editor/src/store/actions.js) -->
diff --git a/docs/reference-guides/data/data-core-blocks.md b/docs/reference-guides/data/data-core-blocks.md
@@ -440,5 +440,4 @@ _Returns_
 
 -   `Object`: Action object.
 
-
 <!-- END TOKEN(Autogenerated actions|../../../packages/blocks/src/store/actions.js) -->
diff --git a/docs/reference-guides/data/data-core-edit-post.md b/docs/reference-guides/data/data-core-edit-post.md
@@ -545,5 +545,4 @@ _Returns_
 
 -   `Object`: Action object.
 
-
 <!-- END TOKEN(Autogenerated actions|../../../packages/edit-post/src/store/actions.js) -->
diff --git a/docs/reference-guides/data/data-core-editor.md b/docs/reference-guides/data/data-core-editor.md
@@ -367,7 +367,7 @@ Return the current block list.
 
 _Parameters_
 
--   _state_ `Object`: 
+-   _state_ `Object`:
 
 _Returns_
 
@@ -379,7 +379,7 @@ Returns the current selection.
 
 _Parameters_
 
--   _state_ `Object`: 
+-   _state_ `Object`:
 
 _Returns_
 
@@ -393,7 +393,7 @@ Returns the current selection end.
 
 _Parameters_
 
--   _state_ `Object`: 
+-   _state_ `Object`:
 
 _Returns_
 
@@ -407,7 +407,7 @@ Returns the current selection start.
 
 _Parameters_
 
--   _state_ `Object`: 
+-   _state_ `Object`:
 
 _Returns_
 
@@ -1094,7 +1094,7 @@ _Related_
 
 ### autosave
 
-Action generator used in signalling that the post should autosave.  This
+Action generator used in signalling that the post should autosave. This
 includes server-side autosaving (default) and client-side (a.k.a. local)
 autosaving (e.g. on the Web, the post might be committed to Session
 Storage).
@@ -1364,7 +1364,7 @@ Action generator for saving the current post in the editor.
 
 _Parameters_
 
--   _options_ `Object`: 
+-   _options_ `Object`:
 
 ### selectBlock
 
@@ -1537,5 +1537,4 @@ _Returns_
 
 -   `Object`: Action object.
 
-
 <!-- END TOKEN(Autogenerated actions|../../../packages/editor/src/store/actions.js) -->
diff --git a/docs/reference-guides/data/data-core-keyboard-shortcuts.md b/docs/reference-guides/data/data-core-keyboard-shortcuts.md
@@ -119,5 +119,4 @@ _Returns_
 
 -   `Object`: action.
 
-
 <!-- END TOKEN(Autogenerated actions|../../../packages/keyboard-shortcuts/src/store/actions.js) -->
diff --git a/docs/reference-guides/data/data-core-notices.md b/docs/reference-guides/data/data-core-notices.md
@@ -134,5 +134,4 @@ _Returns_
 
 -   `Object`: Action object.
 
-
 <!-- END TOKEN(Autogenerated actions|../../../packages/notices/src/store/actions.js) -->
diff --git a/docs/reference-guides/data/data-core-nux.md b/docs/reference-guides/data/data-core-nux.md
@@ -96,5 +96,4 @@ _Returns_
 
 -   `Object`: Action object.
 
-
 <!-- END TOKEN(Autogenerated actions|../../../packages/nux/src/store/actions.js) -->
diff --git a/docs/reference-guides/data/data-core-viewport.md b/docs/reference-guides/data/data-core-viewport.md
@@ -46,5 +46,4 @@ _Returns_
 
 -   `Object`: Action object.
 
-
 <!-- END TOKEN(Autogenerated actions|../../../packages/viewport/src/store/actions.js) -->
diff --git a/docs/reference-guides/data/data-core.md b/docs/reference-guides/data/data-core.md
@@ -707,5 +707,4 @@ _Parameters_
 Action triggered to undo the last edit to
 an entity record, if any.
 
-
 <!-- END TOKEN(Autogenerated actions|../../../packages/core-data/src/actions.js) -->
diff --git a/packages/a11y/README.md b/packages/a11y/README.md
@@ -42,7 +42,6 @@ _Parameters_
 -   _message_ `string`: The message to be announced by assistive technologies.
 -   _ariaLive_ `[string]`: The politeness level for aria-live; default: 'polite'.
 
-
 <!-- END TOKEN(Autogenerated API docs) -->
 
 ### Background

diff --git a/packages/autop/README.md b/packages/autop/README.md
@@ -62,7 +62,6 @@ _Returns_
 
 -   `string`: The content with stripped paragraph tags.
 
-
 <!-- END TOKEN(Autogenerated API docs) -->
 
 <br/><br/><p align="center"><img src="https://s.w.org/style/images/codeispoetry.png?1" alt="Code is Poetry." /></p>
diff --git a/packages/blob/README.md b/packages/blob/README.md
@@ -74,7 +74,6 @@ _Parameters_
 
 -   _url_ `string`: The blob URL.
 
-
 <!-- END TOKEN(Autogenerated API docs) -->
 
 <br/><br/><p align="center"><img src="https://s.w.org/style/images/codeispoetry.png?1" alt="Code is Poetry." /></p>
diff --git a/packages/block-directory/README.md b/packages/block-directory/README.md
@@ -125,8 +125,8 @@ Returns an action object used to indicate install in progress.
 
 _Parameters_
 
--   _blockId_ `string`: 
--   _isInstalling_ `boolean`: 
+-   _blockId_ `string`:
+-   _isInstalling_ `boolean`:
 
 _Returns_
 
@@ -251,7 +251,6 @@ _Returns_
 
 -   `boolean`: Whether a request is in progress for the blocks list.
 
-
 <!-- END TOKEN(Autogenerated selectors|src/store/selectors.js) -->
 
 <br/><br/><p align="center"><img src="https://s.w.org/style/images/codeispoetry.png?1" alt="Code is Poetry." /></p>
diff --git a/packages/block-editor/README.md b/packages/block-editor/README.md
@@ -127,7 +127,7 @@ _Related_
 
 _Parameters_
 
--   _props_ `BlockContextProviderProps`: 
+-   _props_ `BlockContextProviderProps`:
 
 ### BlockControls
 
@@ -222,7 +222,7 @@ _Usage_
 
 _Parameters_
 
--   _props_ `Object`: 
+-   _props_ `Object`:
 -   _props.clientId_ `string`: Client ID of block.
 
 _Returns_
@@ -261,7 +261,7 @@ _Related_
 
 ### ButtonBlockerAppender
 
-> **Deprecated** 
+> **Deprecated**
 
 Use `ButtonBlockAppender` instead.
 
@@ -291,12 +291,15 @@ Use this higher-order component to work with a custom set of colors.
 _Usage_
 
 ```jsx
-const CUSTOM_COLORS = [ { name: 'Red', slug: 'red', color: '#ff0000' }, { name: 'Blue', slug: 'blue', color: '#0000ff' } ];
+const CUSTOM_COLORS = [
+	{ name: 'Red', slug: 'red', color: '#ff0000' },
+	{ name: 'Blue', slug: 'blue', color: '#0000ff' },
+];
 const withCustomColors = createCustomColorsHOC( CUSTOM_COLORS );
 // ...
 export default compose(
-    withCustomColors( 'backgroundColor', 'borderColor' ),
-    MyColorfulComponent,
+	withCustomColors( 'backgroundColor', 'borderColor' ),
+	MyColorfulComponent
 );
 ```
 
@@ -359,8 +362,8 @@ _Returns_
 
 ### getFontSize
 
- Returns the font size object based on an array of named font sizes and the namedFontSize and customFontSize values.
-	If namedFontSize is undefined or not found in fontSizes an object with just the size value based on customFontSize is returned.
+Returns the font size object based on an array of named font sizes and the namedFontSize and customFontSize values.
+If namedFontSize is undefined or not found in fontSizes an object with just the size value based on customFontSize is returned.
 
 _Parameters_
 
@@ -481,7 +484,7 @@ _Related_
 
 ### MultiSelectScrollIntoView
 
-> **Deprecated** 
+> **Deprecated**
 
 Scrolls the multi block selection end into view if not in view already. This
 is important to do after selection by keyboard.
@@ -659,7 +662,7 @@ _Parameters_
 
 -   _props_ `Object`: Optional. Props to pass to the element. Must contain the ref if one is defined.
 -   _options_ `Object`: Options for internal use only.
--   _options.\_\_unstableIsHtml_ `boolean`: 
+-   _options.\_\_unstableIsHtml_ `boolean`:
 
 _Returns_
 
@@ -728,8 +731,8 @@ _Usage_
 
 ```jsx
 export default compose(
-    withColors( 'backgroundColor', { textColor: 'color' } ),
-    MyColorfulComponent,
+	withColors( 'backgroundColor', { textColor: 'color' } ),
+	MyColorfulComponent
 );
 ```
 
@@ -764,7 +767,6 @@ _Parameters_
 -   _props_ `Object`: Component properties.
 -   _props.children_ `WPElement`: Children to be rendered.
 
-
 <!-- END TOKEN(Autogenerated API docs) -->
 
 <br/><br/><p align="center"><img src="https://s.w.org/style/images/codeispoetry.png?1" alt="Code is Poetry." /></p>
diff --git a/packages/block-library/README.md b/packages/block-library/README.md
@@ -88,7 +88,6 @@ _Parameters_
 
 -   _blocks_ `Array`: An optional array of the core blocks being registered.
 
-
 <!-- END TOKEN(Autogenerated API docs) -->
 
 <br/><br/><p align="center"><img src="https://s.w.org/style/images/codeispoetry.png?1" alt="Code is Poetry." /></p>