Improve the base control help prop documentation. (#63693)

* Improve the base control help prop documentation. * Add changelog entry. Co-authored-by: afercia <[email protected]> Co-authored-by: tyxla <[email protected]>
WordPress · Jul 22, 2024 · d0b82da · d0b82da
1 parent 18c5c6a
commit d0b82da
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 2 deletions.
diff --git a/packages/components/CHANGELOG.md b/packages/components/CHANGELOG.md
@@ -28,6 +28,10 @@
 -   `Tabs`: Vertical Tabs should be 40px min height. ([#63446](https://github.com/WordPress/gutenberg/pull/63446)).
 -   `ColorPicker`: Use `minimal` variant for `SelectControl` ([#63676](https://github.com/WordPress/gutenberg/pull/63676)).
 
+### Documentation
+
+-   `BaseControl`: Improve the base control help prop documentation. ([#63693](https://github.com/WordPress/gutenberg/pull/63693)).
+
 ## 28.3.0 (2024-07-10)
 
 ### Enhancements

diff --git 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
@@ -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;
 	/**