Skip to content

Commit

Permalink
update markdown docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jorgefilipecosta committed Dec 3, 2024
1 parent e852af2 commit 1aa325b
Show file tree
Hide file tree
Showing 5 changed files with 12 additions and 12 deletions.
8 changes: 4 additions & 4 deletions docs/reference-guides/data/data-core-blocks.md
Original file line number Diff line number Diff line change
Expand Up @@ -385,7 +385,7 @@ _Parameters_

_Returns_

- `string?`: Default block name.
- `?string`: Default block name.

### getDefaultBlockVariation

Expand Down Expand Up @@ -464,7 +464,7 @@ _Parameters_

_Returns_

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

### getGroupingBlockName

Expand Down Expand Up @@ -502,7 +502,7 @@ _Parameters_

_Returns_

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

### getUnregisteredFallbackBlockName

Expand Down Expand Up @@ -540,7 +540,7 @@ _Parameters_

_Returns_

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

### hasBlockSupport

Expand Down
2 changes: 1 addition & 1 deletion docs/reference-guides/data/data-core-editor.md
Original file line number Diff line number Diff line change
Expand Up @@ -272,7 +272,7 @@ _Parameters_

_Returns_

- `string?`: Template ID.
- `?string`: Template ID.

### getDeviceType

Expand Down
4 changes: 2 additions & 2 deletions docs/reference-guides/data/data-core-keyboard-shortcuts.md
Original file line number Diff line number Diff line change
Expand Up @@ -239,7 +239,7 @@ _Parameters_

_Returns_

- `string?`: Shortcut description.
- `?string`: Shortcut description.

### getShortcutKeyCombination

Expand Down Expand Up @@ -335,7 +335,7 @@ _Parameters_

_Returns_

- `string?`: Shortcut representation.
- `?string`: Shortcut representation.

<!-- END TOKEN(Autogenerated selectors|../../../packages/keyboard-shortcuts/src/store/selectors.js) -->

Expand Down
2 changes: 1 addition & 1 deletion packages/date/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ Create and return a JavaScript Date Object from a date string in the WP timezone

_Parameters_

- _dateString_ `string?`: Date formatted in the WP timezone.
- _dateString_ `?string`: Date formatted in the WP timezone.

_Returns_

Expand Down
8 changes: 4 additions & 4 deletions packages/e2e-test-utils/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -253,8 +253,8 @@ _Parameters_

- _slug_ `string`: Theme slug.
- _settings_ `Object?`: Optional settings object.
- _settings.newThemeSlug_ `string?`: A theme to switch to if the theme to delete is active. Required if the theme to delete is active.
- _settings.newThemeSearchTerm_ `string?`: A search term to use if the new theme is not findable by its slug.
- _settings.newThemeSlug_ `?string`: A theme to switch to if the theme to delete is active. Required if the theme to delete is active.
- _settings.newThemeSearchTerm_ `?string`: A search term to use if the new theme is not findable by its slug.

### deleteUser

Expand Down Expand Up @@ -479,7 +479,7 @@ Installs a plugin from the WP.org repository.
_Parameters_

- _slug_ `string`: Plugin slug.
- _searchTerm_ `string?`: If the plugin is not findable by its slug use an alternative term to search.
- _searchTerm_ `?string`: If the plugin is not findable by its slug use an alternative term to search.

### installTheme

Expand All @@ -489,7 +489,7 @@ _Parameters_

- _slug_ `string`: Theme slug.
- _settings_ `Object?`: Optional settings object.
- _settings.searchTerm_ `string?`: Search term to use if the theme is not findable by its slug.
- _settings.searchTerm_ `?string`: Search term to use if the theme is not findable by its slug.

### isCurrentURL

Expand Down

0 comments on commit 1aa325b

Please sign in to comment.