Documentation: PostSwitchToDraftButton editor component (WordPress#62381

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

Hide file tree

Showing 2 changed files with 10 additions and 2 deletions.
diff --git a/packages/editor/README.md b/packages/editor/README.md
@@ -1270,7 +1270,11 @@ Undocumented declaration.
 
 ### PostSwitchToDraftButton
 
-Undocumented declaration.
+Renders a button component that allows the user to switch a post to draft status.
+
+_Returns_
+
+-   `JSX.Element`: The rendered component.
 
 ### PostSyncStatus
 

diff --git a/packages/editor/src/components/post-switch-to-draft-button/index.js b/packages/editor/src/components/post-switch-to-draft-button/index.js
@@ -14,7 +14,11 @@ import { useState } from '@wordpress/element';
  */
 import { store as editorStore } from '../../store';
 
-// TODO: deprecate..
+/**
+ * Renders a button component that allows the user to switch a post to draft status.
+ *
+ * @return {JSX.Element} The rendered component.
+ */
 export default function PostSwitchToDraftButton() {
 	const [ showConfirmDialog, setShowConfirmDialog ] = useState( false );