From 1aa325bfaf19e01027aa3b33bb137f38689f1ee7 Mon Sep 17 00:00:00 2001 From: Jorge Costa Date: Tue, 3 Dec 2024 12:52:26 +0000 Subject: [PATCH] update markdown docs --- docs/reference-guides/data/data-core-blocks.md | 8 ++++---- docs/reference-guides/data/data-core-editor.md | 2 +- .../reference-guides/data/data-core-keyboard-shortcuts.md | 4 ++-- packages/date/README.md | 2 +- packages/e2e-test-utils/README.md | 8 ++++---- 5 files changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/reference-guides/data/data-core-blocks.md b/docs/reference-guides/data/data-core-blocks.md index 084c9c1d7a5fbc..158b7f92529122 100644 --- a/docs/reference-guides/data/data-core-blocks.md +++ b/docs/reference-guides/data/data-core-blocks.md @@ -385,7 +385,7 @@ _Parameters_ _Returns_ -- `string?`: Default block name. +- `?string`: Default block name. ### getDefaultBlockVariation @@ -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 @@ -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 @@ -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 diff --git a/docs/reference-guides/data/data-core-editor.md b/docs/reference-guides/data/data-core-editor.md index 44078ab284e94f..a9f07104bd3b6e 100644 --- a/docs/reference-guides/data/data-core-editor.md +++ b/docs/reference-guides/data/data-core-editor.md @@ -272,7 +272,7 @@ _Parameters_ _Returns_ -- `string?`: Template ID. +- `?string`: Template ID. ### getDeviceType diff --git a/docs/reference-guides/data/data-core-keyboard-shortcuts.md b/docs/reference-guides/data/data-core-keyboard-shortcuts.md index d7d5cf853f7865..426fb316021a42 100644 --- a/docs/reference-guides/data/data-core-keyboard-shortcuts.md +++ b/docs/reference-guides/data/data-core-keyboard-shortcuts.md @@ -239,7 +239,7 @@ _Parameters_ _Returns_ -- `string?`: Shortcut description. +- `?string`: Shortcut description. ### getShortcutKeyCombination @@ -335,7 +335,7 @@ _Parameters_ _Returns_ -- `string?`: Shortcut representation. +- `?string`: Shortcut representation. diff --git a/packages/date/README.md b/packages/date/README.md index ed2dfdd4790324..4f0a64c24aa713 100644 --- a/packages/date/README.md +++ b/packages/date/README.md @@ -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_ diff --git a/packages/e2e-test-utils/README.md b/packages/e2e-test-utils/README.md index 196768b0e2487c..30548961db26a4 100644 --- a/packages/e2e-test-utils/README.md +++ b/packages/e2e-test-utils/README.md @@ -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 @@ -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 @@ -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