Documentation: PostSyncStatus editor component (WordPress#62382)

* Add JSDoc block for PostSyncStatus editor component * Auto-generate editor docs for PostSyncStatus component
patil-vipul · Jun 17, 2024 · ac8f7e8 · ac8f7e8
1 parent aa48ac7
commit ac8f7e8
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 1 deletion.
diff --git a/packages/editor/README.md b/packages/editor/README.md
@@ -1274,7 +1274,11 @@ Undocumented declaration.
 
 ### PostSyncStatus
 
-Undocumented declaration.
+Renders the sync status of a post.
+
+_Returns_
+
+-   `JSX.Element|null`: The rendered sync status component.
 
 ### PostTaxonomies
 

diff --git a/packages/editor/src/components/post-sync-status/index.js b/packages/editor/src/components/post-sync-status/index.js
@@ -10,6 +10,11 @@ import { __, _x } from '@wordpress/i18n';
 import PostPanelRow from '../post-panel-row';
 import { store as editorStore } from '../../store';
 
+/**
+ * Renders the sync status of a post.
+ *
+ * @return {JSX.Element|null} The rendered sync status component.
+ */
 export default function PostSyncStatus() {
 	const { syncStatus, postType } = useSelect( ( select ) => {
 		const { getEditedPostAttribute } = select( editorStore );