Add doc for WordCount component (WordPress#62217)

patil-vipul · Jun 17, 2024 · 7200573 · 7200573
1 parent 73545b8
commit 7200573
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
@@ -1592,7 +1592,11 @@ Undocumented declaration.
 
 ### WordCount
 
-Undocumented declaration.
+Renders the word count of the post content.
+
+_Returns_
+
+-   `JSX.Element|null`: The rendered WordCount component.
 
 ### WritingFlow
 

diff --git a/packages/editor/src/components/word-count/index.js b/packages/editor/src/components/word-count/index.js
@@ -10,6 +10,11 @@ import { count as wordCount } from '@wordpress/wordcount';
  */
 import { store as editorStore } from '../../store';
 
+/**
+ * Renders the word count of the post content.
+ *
+ * @return {JSX.Element|null} The rendered WordCount component.
+ */
 export default function WordCount() {
 	const content = useSelect(
 		( select ) => select( editorStore ).getEditedPostAttribute( 'content' ),