Improved doc comments

eea · Aug 17, 2020 · 70969a2 · 70969a2
1 parent 3d4f6fd
commit 70969a2
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/src/blocks/Text/extensions/withDeserializers.js b/src/blocks/Text/extensions/withDeserializers.js
@@ -1,5 +1,10 @@
 import { blockTagDeserializer } from 'volto-slate/editor/deserialize';
+import { Editor } from 'slate';
 
+/**
+ * This extension just replaces the `<h1>` tag deserializer with the one for `<h2>` tags. The rest of the default deserializers inherited from the `SlateEditor` component are good already.
+ * @param {Editor} editor The Slate editor object to extend.
+ */
 export const withDeserializers = (editor) => {
   editor.htmlTagsToSlate = {
     ...editor.htmlTagsToSlate,