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.

Sign up for GitHub

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

Jump to bottom

Docs: use markdown headings instead of links for API declarations #33381

Merged
merged 6 commits into from Jul 14, 2021
Merged

Docs: use markdown headings instead of links for API declarations #33381

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
284c040
symbol name as proper heading level 2
juanmaguitar Jul 12, 2021
10b97d2
Merge branch 'WordPress:trunk' into docgen-fix-heading-symbol
juanmaguitar Jul 13, 2021
32245fd
Merge branch 'WordPress:trunk' into docgen-fix-heading-symbol
juanmaguitar Jul 13, 2021
511339b
added generated md w/ proper headings for symbol names
juanmaguitar Jul 13, 2021
fb2f09f
modified test to include change in formatter
juanmaguitar Jul 13, 2021
8d6272b
removed coverage folder
juanmaguitar Jul 14, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
240 changes: 120 additions & 120 deletions docs/reference-guides/data/data-core-block-editor.md
View file
Open in desktop

Large diffs are not rendered by default.

64 changes: 32 additions & 32 deletions docs/reference-guides/data/data-core-blocks.md
View file
Open in desktop
Expand Up @@ -6,7 +6,7 @@ Namespace: `core/blocks`.

<!-- START TOKEN(Autogenerated selectors|../../../packages/blocks/src/store/selectors.js) -->

<a name="getActiveBlockVariation" href="#getActiveBlockVariation">#</a> **getActiveBlockVariation**
### getActiveBlockVariation

Returns the active block variation for a given block based on its attributes.
Variations are determined by their `isActive` property.
Expand All @@ -30,7 +30,7 @@ _Returns_

- `(WPBlockVariation|undefined)`: Active block variation.

<a name="getBlockStyles" href="#getBlockStyles">#</a> **getBlockStyles**
### getBlockStyles

Returns block styles by block name.

Expand All @@ -43,7 +43,7 @@ _Returns_

- `Array?`: Block Styles.

<a name="getBlockSupport" href="#getBlockSupport">#</a> **getBlockSupport**
### getBlockSupport

Returns the block support value for a feature, if defined.

Expand All @@ -58,7 +58,7 @@ _Returns_

- `?*`: Block support value

<a name="getBlockType" href="#getBlockType">#</a> **getBlockType**
### getBlockType

Returns a block type by name.

Expand All @@ -71,7 +71,7 @@ _Returns_

- `Object?`: Block Type.

<a name="getBlockTypes" href="#getBlockTypes">#</a> **getBlockTypes**
### getBlockTypes

Returns all the available block types.

Expand All @@ -83,7 +83,7 @@ _Returns_

- `Array`: Block Types.

<a name="getBlockVariations" href="#getBlockVariations">#</a> **getBlockVariations**
### getBlockVariations

Returns block variations by block name.

Expand All @@ -97,7 +97,7 @@ _Returns_

- `(WPBlockVariation[]|void)`: Block variations.

<a name="getCategories" href="#getCategories">#</a> **getCategories**
### getCategories

Returns all the available categories.

Expand All @@ -109,7 +109,7 @@ _Returns_

- `WPBlockCategory[]`: Categories list.

<a name="getChildBlockNames" href="#getChildBlockNames">#</a> **getChildBlockNames**
### getChildBlockNames

Returns an array with the child blocks of a given block.

Expand All @@ -122,7 +122,7 @@ _Returns_

- `Array`: Array of child block names.

<a name="getCollections" href="#getCollections">#</a> **getCollections**
### getCollections

Returns all the available collections.

Expand All @@ -134,7 +134,7 @@ _Returns_

- `Object`: Collections list.

<a name="getDefaultBlockName" href="#getDefaultBlockName">#</a> **getDefaultBlockName**
### getDefaultBlockName

Returns the name of the default block name.

Expand All @@ -146,7 +146,7 @@ _Returns_

- `string?`: Default block name.

<a name="getDefaultBlockVariation" href="#getDefaultBlockVariation">#</a> **getDefaultBlockVariation**
### getDefaultBlockVariation

Returns the default block variation for the given block type.
When there are multiple variations annotated as the default one,
Expand All @@ -163,7 +163,7 @@ _Returns_

- `?WPBlockVariation`: The default block variation.

<a name="getFreeformFallbackBlockName" href="#getFreeformFallbackBlockName">#</a> **getFreeformFallbackBlockName**
### getFreeformFallbackBlockName

Returns the name of the block for handling non-block content.

Expand All @@ -175,7 +175,7 @@ _Returns_

- `string?`: Name of the block for handling non-block content.

<a name="getGroupingBlockName" href="#getGroupingBlockName">#</a> **getGroupingBlockName**
### getGroupingBlockName

Returns the name of the block for handling unregistered blocks.

Expand All @@ -187,7 +187,7 @@ _Returns_

- `string?`: Name of the block for handling unregistered blocks.

<a name="getUnregisteredFallbackBlockName" href="#getUnregisteredFallbackBlockName">#</a> **getUnregisteredFallbackBlockName**
### getUnregisteredFallbackBlockName

Returns the name of the block for handling unregistered blocks.

Expand All @@ -199,7 +199,7 @@ _Returns_

- `string?`: Name of the block for handling unregistered blocks.

<a name="hasBlockSupport" href="#hasBlockSupport">#</a> **hasBlockSupport**
### hasBlockSupport

Returns true if the block defines support for a feature, or false otherwise.

Expand All @@ -214,7 +214,7 @@ _Returns_

- `boolean`: Whether block supports feature.

<a name="hasChildBlocks" href="#hasChildBlocks">#</a> **hasChildBlocks**
### hasChildBlocks

Returns a boolean indicating if a block has child blocks or not.

Expand All @@ -227,7 +227,7 @@ _Returns_

- `boolean`: True if a block contains child blocks and false otherwise.

<a name="hasChildBlocksWithInserterSupport" href="#hasChildBlocksWithInserterSupport">#</a> **hasChildBlocksWithInserterSupport**
### hasChildBlocksWithInserterSupport

Returns a boolean indicating if a block has at least one child block with inserter support.

Expand All @@ -240,7 +240,7 @@ _Returns_

- `boolean`: True if a block contains at least one child blocks with inserter support and false otherwise.

<a name="isMatchingSearchTerm" href="#isMatchingSearchTerm">#</a> **isMatchingSearchTerm**
### isMatchingSearchTerm

Returns true if the block type by the given name or object value matches a
search term, or false otherwise.
Expand All @@ -261,7 +261,7 @@ _Returns_

<!-- START TOKEN(Autogenerated actions|../../../packages/blocks/src/store/actions.js) -->

<a name="addBlockCollection" href="#addBlockCollection">#</a> **addBlockCollection**
### addBlockCollection

Returns an action object used to add block collections

Expand All @@ -275,7 +275,7 @@ _Returns_

- `Object`: Action object.

<a name="addBlockStyles" href="#addBlockStyles">#</a> **addBlockStyles**
### addBlockStyles

Returns an action object used in signalling that new block styles have been added.

Expand All @@ -288,7 +288,7 @@ _Returns_

- `Object`: Action object.

<a name="addBlockTypes" href="#addBlockTypes">#</a> **addBlockTypes**
### addBlockTypes

Returns an action object used in signalling that block types have been added.

Expand All @@ -300,7 +300,7 @@ _Returns_

- `Object`: Action object.

<a name="addBlockVariations" href="#addBlockVariations">#</a> **addBlockVariations**
### addBlockVariations

Returns an action object used in signalling that new block variations have been added.

Expand All @@ -313,7 +313,7 @@ _Returns_

- `Object`: Action object.

<a name="removeBlockCollection" href="#removeBlockCollection">#</a> **removeBlockCollection**
### removeBlockCollection

Returns an action object used to remove block collections

Expand All @@ -325,7 +325,7 @@ _Returns_

- `Object`: Action object.

<a name="removeBlockStyles" href="#removeBlockStyles">#</a> **removeBlockStyles**
### removeBlockStyles

Returns an action object used in signalling that block styles have been removed.

Expand All @@ -338,7 +338,7 @@ _Returns_

- `Object`: Action object.

<a name="removeBlockTypes" href="#removeBlockTypes">#</a> **removeBlockTypes**
### removeBlockTypes

Returns an action object used to remove a registered block type.

Expand All @@ -350,7 +350,7 @@ _Returns_

- `Object`: Action object.

<a name="removeBlockVariations" href="#removeBlockVariations">#</a> **removeBlockVariations**
### removeBlockVariations

Returns an action object used in signalling that block variations have been removed.

Expand All @@ -363,7 +363,7 @@ _Returns_

- `Object`: Action object.

<a name="setCategories" href="#setCategories">#</a> **setCategories**
### setCategories

Returns an action object used to set block categories.

Expand All @@ -375,7 +375,7 @@ _Returns_

- `Object`: Action object.

<a name="setDefaultBlockName" href="#setDefaultBlockName">#</a> **setDefaultBlockName**
### setDefaultBlockName

Returns an action object used to set the default block name.

Expand All @@ -387,7 +387,7 @@ _Returns_

- `Object`: Action object.

<a name="setFreeformFallbackBlockName" href="#setFreeformFallbackBlockName">#</a> **setFreeformFallbackBlockName**
### setFreeformFallbackBlockName

Returns an action object used to set the name of the block used as a fallback
for non-block content.
Expand All @@ -400,7 +400,7 @@ _Returns_

- `Object`: Action object.

<a name="setGroupingBlockName" href="#setGroupingBlockName">#</a> **setGroupingBlockName**
### setGroupingBlockName

Returns an action object used to set the name of the block used
when grouping other blocks
Expand All @@ -414,7 +414,7 @@ _Returns_

- `Object`: Action object.

<a name="setUnregisteredFallbackBlockName" href="#setUnregisteredFallbackBlockName">#</a> **setUnregisteredFallbackBlockName**
### setUnregisteredFallbackBlockName

Returns an action object used to set the name of the block used as a fallback
for unregistered blocks.
Expand All @@ -427,7 +427,7 @@ _Returns_

- `Object`: Action object.

<a name="updateCategory" href="#updateCategory">#</a> **updateCategory**
### updateCategory

Returns an action object used to update a category.

Expand Down