Add JSDoc for password field export and update README

WordPress · Oct 31, 2024 · 6abc19e · 6abc19e
1 parent 02b8eb0
commit 6abc19e
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/packages/fields/README.md b/packages/fields/README.md
@@ -52,7 +52,7 @@ This field is used to display the post parent.
 
 ### passwordField
 
-Undocumented declaration.
+This field is used to display the post password.
 
 ### permanentlyDeletePost
 

diff --git a/packages/fields/src/fields/password/index.tsx b/packages/fields/src/fields/password/index.tsx
@@ -19,4 +19,7 @@ const passwordField: Field< BasePost > = {
 	isVisible: ( item ) => item.status !== 'private',
 };
 
+/**
+ * This field is used to display the post password.
+ */
 export default passwordField;