fix: Update d2l-dialog describe-content doc comment (#5228)

BrightspaceUI · Dec 11, 2024 · 67d17b0 · 67d17b0
1 parent 20e9739
commit 67d17b0
Showing 1 changed file with 1 addition and 1 deletion.
diff --git a/components/dialog/dialog.js b/components/dialog/dialog.js
@@ -35,7 +35,7 @@ class Dialog extends PropertyRequiredMixin(LocalizeCoreElement(AsyncContainerMix
 			critical: { type: Boolean },
 
 			/**
-			 * Whether to read the contents of the dialog on open
+			 * Causes screen readers to announce the content of the dialog on open. Only use if the content is concise and contains only text since screen readers ignore HTML semantics and some have a ~250 character limit.
 			 */
 			describeContent: { type: Boolean, attribute: 'describe-content' },