Add documentation for the EditorNotices component (#61736)

Co-authored-by: nateinaction <[email protected]> Co-authored-by: colorful-tones <[email protected]>
WordPress · May 21, 2024 · 0f68078 · 0f68078 · github-actions · May 21, 2024
1 parent 9acffd0
commit 0f68078
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 1 deletion.
diff --git a/packages/editor/README.md b/packages/editor/README.md
@@ -336,7 +336,17 @@ _Returns_
 
 ### EditorNotices
 
-Undocumented declaration.
+This component renders the notices displayed in the editor. It displays pinned notices first, followed by dismissible
+
+_Usage_
+
+```jsx
+<EditorNotices />
+```
+
+_Returns_
+
+-   `JSX.Element`: The rendered EditorNotices component.
 
 ### EditorProvider
 

diff --git a/packages/editor/src/components/editor-notices/index.js b/packages/editor/src/components/editor-notices/index.js
@@ -10,6 +10,16 @@ import { store as noticesStore } from '@wordpress/notices';
  */
 import TemplateValidationNotice from '../template-validation-notice';
 
+/**
+ * This component renders the notices displayed in the editor. It displays pinned notices first, followed by dismissible
+ *
+ * @example
+ * ```jsx
+ * <EditorNotices />
+ * ```
+ *
+ * @return {JSX.Element} The rendered EditorNotices component.
+ */
 export function EditorNotices() {
 	const { notices } = useSelect(
 		( select ) => ( {