From 6abc19e492b8b778be8a301d7798e51fe8f47b2e Mon Sep 17 00:00:00 2001
From: Lourens Schep <lourensschep@gmail.com>
Date: Thu, 31 Oct 2024 11:15:08 +0100
Subject: [PATCH] Add JSDoc for password field export and update README

---
 packages/fields/README.md                     | 2 +-
 packages/fields/src/fields/password/index.tsx | 3 +++
 2 files changed, 4 insertions(+), 1 deletion(-)

diff --git a/packages/fields/README.md b/packages/fields/README.md
index e5fa8851fc5b2b..214f3d6ee3a50a 100644
--- 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
index e8d55c08af2ab3..aa7bc57e3f7cae 100644
--- 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;