From 735260589c5a5f3f9a6a04198a60aa62176ee21a Mon Sep 17 00:00:00 2001 From: Andrea Fercia Date: Thu, 18 Jul 2024 10:44:24 +0200 Subject: [PATCH 1/2] Improve the base control help prop documentation. --- packages/components/src/base-control/README.md | 2 +- packages/components/src/base-control/types.ts | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/components/src/base-control/README.md b/packages/components/src/base-control/README.md index bc46629d2b618..dc3d8c0e29c8e 100644 --- a/packages/components/src/base-control/README.md +++ b/packages/components/src/base-control/README.md @@ -53,7 +53,7 @@ If true, the label will only be visible to screen readers. ### help -Additional description for the control. The element containing the description will be programmatically associated to the BaseControl by the means of an `aria-describedby` attribute. +Additional description for the control. Only use for meaningful description or instructions for the control. An element containing the description will be programmatically associated to the BaseControl by the means of an `aria-describedby` attribute. - Type: `ReactNode` - Required: No diff --git a/packages/components/src/base-control/types.ts b/packages/components/src/base-control/types.ts index eeb8736cf1b95..07a358d09c14b 100644 --- a/packages/components/src/base-control/types.ts +++ b/packages/components/src/base-control/types.ts @@ -21,7 +21,7 @@ export type BaseControlProps = { /** * Additional description for the control. * - * The element containing the description will be programmatically associated to the BaseControl by the means of an `aria-describedby` attribute. + * Only use for meaningful description or instructions for the control. An element containing the description will be programmatically associated to the BaseControl by the means of an `aria-describedby` attribute. */ help?: ReactNode; /** From a74845d679fd1ceb43b79d7367799e8d44538a52 Mon Sep 17 00:00:00 2001 From: Andrea Fercia Date: Thu, 18 Jul 2024 10:53:26 +0200 Subject: [PATCH 2/2] Add changelog entry. --- packages/components/CHANGELOG.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/packages/components/CHANGELOG.md b/packages/components/CHANGELOG.md index 392d11fdd6673..aa3b671b8761e 100644 --- a/packages/components/CHANGELOG.md +++ b/packages/components/CHANGELOG.md @@ -26,6 +26,10 @@ - `DropdownMenuV2`: invert animation direction. ([#63443](https://github.com/WordPress/gutenberg/pull/63443)). - `Tabs`: Vertical Tabs should be 40px min height. ([#63446](https://github.com/WordPress/gutenberg/pull/63446)). +### Documentation + +- `BaseControl`: Improve the base control help prop documentation. ([#63693](https://github.com/WordPress/gutenberg/pull/63693)). + ## 28.3.0 (2024-07-10) ### Enhancements