improve documentation for fields package (#67580)

Author: gigitux

packages/fields/README.md

@@ -41,107 +41,91 @@ Date field for BasePost.
 
 ### deletePost
 
-Undocumented declaration.
+Delete action for Templates, Patterns and Template Parts.
 
 ### duplicatePattern
 
-Undocumented declaration.
+Duplicate action for Pattern.
 
 ### duplicatePost
 
-Undocumented declaration.
-
-### duplicatePostNative
-
-Undocumented declaration.
+Duplicate action for BasePost.
 
 ### duplicateTemplatePart
 
-This action is used to duplicate a template part.
-
-_Type_
-
--   `Action< TemplatePart >`
+Duplicate action for TemplatePart.
 
 ### exportPattern
 
-Undocumented declaration.
-
-### exportPatternNative
-
-Undocumented declaration.
+Export action as JSON for Pattern.
 
 ### featuredImageField
 
-Undocumented declaration.
+Featured Image field for BasePost.
 
 ### orderField
 
-Undocumented declaration.
+Order field for BasePost.
 
 ### parentField
 
-This field is used to display the post parent.
+Parent field for BasePost.
 
 ### passwordField
 
-This field is used to display the post password.
+Password field for BasePost.
 
 ### permanentlyDeletePost
 
-Undocumented declaration.
+Delete action for PostWithPermissions.
 
 ### PostType
 
 Undocumented declaration.
 
 ### renamePost
 
-Undocumented declaration.
+Rename action for PostWithPermissions.
 
 ### reorderPage
 
-Undocumented declaration.
-
-### reorderPageNative
-
-Undocumented declaration.
+Reorder action for BasePost.
 
 ### resetPost
 
-Undocumented declaration.
+Reset action for Template and TemplatePart.
 
 ### restorePost
 
-Undocumented declaration.
+Restore action for PostWithPermissions.
 
 ### slugField
 
-Undocumented declaration.
+Slug field for BasePost.
 
 ### statusField
 
 Status field for BasePost.
 
 ### templateField
 
-Undocumented declaration.
+Template field for BasePost.
 
 ### titleField
 
-Undocumented declaration.
+Title field for BasePost.
 
 ### trashPost
 
-Undocumented declaration.
+Trash action for PostWithPermissions.
 
 ### viewPost
 
-Undocumented declaration.
+View post action for BasePost.
 
 ### viewPostRevisions
 
-Undocumented declaration.
+View post revisions action for Post.
 
 <!-- END TOKEN(Autogenerated API docs) -->
 

packages/fields/src/actions/delete-post.tsx

@@ -203,4 +203,7 @@ const deletePostAction: Action< Template | TemplatePart | Pattern > = {
 	},
 };
 
+/**
+ * Delete action for Templates, Patterns and Template Parts.
+ */
 export default deletePostAction;

packages/fields/src/actions/duplicate-pattern.tsx

@@ -37,4 +37,7 @@ const duplicatePattern: Action< Pattern > = {
 	},
 };
 
+/**
+ * Duplicate action for Pattern.
+ */
 export default duplicatePattern;

packages/fields/src/actions/duplicate-post.native.tsx

@@ -37,8 +37,8 @@ const duplicatePost: Action< BasePost > = {
 		const [ item, setItem ] = useState< BasePost >( {
 			...items[ 0 ],
 			title: sprintf(
-				/* translators: %s: Existing template title */
-				_x( '%s (Copy)', 'template' ),
+				/* translators: %s: Existing post title */
+				_x( '%s (Copy)', 'post' ),
 				getItemTitle( items[ 0 ] )
 			),
 		} );
@@ -104,7 +104,7 @@ const duplicatePost: Action< BasePost > = {
 
 				createSuccessNotice(
 					sprintf(
-						// translators: %s: Title of the created post or template, e.g: "Hello world".
+						// translators: %s: Title of the created post, e.g: "Hello world".
 						__( '"%s" successfully created.' ),
 						decodeEntities( newItem.title?.rendered || item.title )
 					),
@@ -171,4 +171,7 @@ const duplicatePost: Action< BasePost > = {
 	},
 };
 
+/**
+ * Duplicate action for BasePost.
+ */
 export default duplicatePost;

packages/fields/src/actions/duplicate-post.tsx

@@ -68,5 +68,7 @@ const duplicateTemplatePart: Action< TemplatePart > = {
 		);
 	},
 };
-
+/**
+ * Duplicate action for TemplatePart.
+ */
 export default duplicateTemplatePart;

packages/fields/src/actions/duplicate-template-part.tsx

@@ -73,4 +73,7 @@ const exportPattern: Action< Pattern > = {
 	},
 };
 
+/**
+ * Export action as JSON for Pattern.
+ */
 export default exportPattern;

packages/fields/src/actions/export-pattern.native.tsx

@@ -1,13 +1,10 @@
 export { default as viewPost } from './view-post';
 export { default as reorderPage } from './reorder-page';
-export { default as reorderPageNative } from './reorder-page.native';
 export { default as duplicatePost } from './duplicate-post';
-export { default as duplicatePostNative } from './duplicate-post.native';
 export { default as renamePost } from './rename-post';
 export { default as resetPost } from './reset-post';
 export { default as duplicatePattern } from './duplicate-pattern';
 export { default as exportPattern } from './export-pattern';
-export { default as exportPatternNative } from './export-pattern.native';
 export { default as viewPostRevisions } from './view-post-revisions';
 export { default as permanentlyDeletePost } from './permanently-delete-post';
 export { default as restorePost } from './restore-post';

packages/fields/src/actions/export-pattern.tsx

@@ -115,4 +115,7 @@ const permanentlyDeletePost: Action< PostWithPermissions > = {
 	},
 };
 
+/**
+ * Delete action for PostWithPermissions.
+ */
 export default permanentlyDeletePost;

packages/fields/src/actions/index.ts

@@ -139,4 +139,7 @@ const renamePost: Action< PostWithPermissions > = {
 	},
 };
 
+/**
+ * Rename action for PostWithPermissions.
+ */
 export default renamePost;

packages/fields/src/actions/permanently-delete-post.tsx

@@ -122,4 +122,7 @@ const reorderPage: Action< BasePost > = {
 	RenderModal: ReorderModal,
 };
 
+/**
+ * Reorder action for BasePost.
+ */
 export default reorderPage;

packages/fields/src/actions/rename-post.tsx

@@ -292,4 +292,7 @@ const resetPostAction: Action< Template | TemplatePart > = {
 	},
 };
 
+/**
+ * Reset action for Template and TemplatePart.
+ */
 export default resetPostAction;

packages/fields/src/actions/reorder-page.native.tsx

@@ -131,4 +131,7 @@ const restorePost: Action< PostWithPermissions > = {
 	},
 };
 
+/**
+ * Restore action for PostWithPermissions.
+ */
 export default restorePost;

packages/fields/src/actions/reorder-page.tsx

@@ -195,4 +195,7 @@ const trashPost: Action< PostWithPermissions > = {
 	},
 };
 
+/**
+ * Trash action for PostWithPermissions.
+ */
 export default trashPost;

packages/fields/src/actions/reset-post.tsx

@@ -44,4 +44,7 @@ const viewPostRevisions: Action< Post > = {
 	},
 };
 
+/**
+ * View post revisions action for Post.
+ */
 export default viewPostRevisions;

packages/fields/src/actions/restore-post.tsx

@@ -27,4 +27,7 @@ const viewPost: Action< BasePost > = {
 	},
 };
 
+/**
+ * View post action for BasePost.
+ */
 export default viewPost;

packages/fields/src/actions/trash-post.tsx

@@ -20,4 +20,7 @@ const featuredImageField: Field< BasePost > = {
 	enableSorting: false,
 };
 
+/**
+ * Featured Image field for BasePost.
+ */
 export default featuredImageField;

packages/fields/src/actions/view-post-revisions.tsx

@@ -16,4 +16,7 @@ const orderField: Field< BasePost > = {
 	description: __( 'Determines the order of pages.' ),
 };
 
+/**
+ * Order field for BasePost.
+ */
 export default orderField;

packages/fields/src/actions/view-post.tsx

@@ -21,6 +21,6 @@ const parentField: Field< BasePost > = {
 };
 
 /**
- * This field is used to display the post parent.
+ * Parent field for BasePost.
  */
 export default parentField;

packages/fields/src/fields/featured-image/index.ts

@@ -19,6 +19,6 @@ const passwordField: Field< BasePost > = {
 };
 
 /**
- * This field is used to display the post password.
+ * Password field for BasePost.
  */
 export default passwordField;

packages/fields/src/fields/order/index.ts

@@ -19,4 +19,7 @@ const slugField: Field< BasePost > = {
 	render: SlugView,
 };
 
+/**
+ * Slug field for BasePost.
+ */
 export default slugField;

packages/fields/src/fields/parent/index.ts

@@ -14,9 +14,11 @@ const templateField: Field< BasePost > = {
 	id: 'template',
 	type: 'text',
 	label: __( 'Template' ),
-	getValue: ( { item } ) => item.template,
 	Edit: TemplateEdit,
 	enableSorting: false,
 };
 
+/**
+ * Template field for BasePost.
+ */
 export default templateField;

packages/fields/src/fields/password/index.tsx

@@ -21,4 +21,7 @@ const titleField: Field< BasePost > = {
 	enableHiding: false,
 };
 
+/**
+ * Title field for BasePost.
+ */
 export default titleField;

packages/fields/src/fields/slug/index.ts

@@ -1,2 +0,0 @@
-export * from './actions/duplicate-post.native';
-export * from './actions/reorder-page.native';