diff --git a/packages/editor/README.md b/packages/editor/README.md index 4142a1f68a51a..1fdb1d0918f5a 100644 --- 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 + +``` + +_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 index a25d3fa40a204..28341bfda3f23 100644 --- 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 + * + * ``` + * + * @return {JSX.Element} The rendered EditorNotices component. + */ export function EditorNotices() { const { notices } = useSelect( ( select ) => ( {