add jsdoc for mapRichTextSettings util

WordPress · Apr 13, 2022 · e8b0901 · e8b0901
1 parent d2bacd5
commit e8b0901
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/packages/block-editor/src/store/utils.js b/packages/block-editor/src/store/utils.js
@@ -1,3 +1,10 @@
+/**
+ * Helper function that maps attribute definition properties to the
+ * ones used by RichText utils like `create, toHTMLString, etc..`.
+ *
+ * @param {Object} attributeDefinition A block's attribute definition object.
+ * @return {Object} The mapped object.
+ */
 export function mapRichTextSettings( attributeDefinition ) {
 	const {
 		multiline: multilineTag,