docs: update migrating guide for plugins renderer

ref: #354
lepture · Aug 18, 2023 · 68a2814 · 68a2814
1 parent b81197d
commit 68a2814
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/docs/upgrade.rst b/docs/upgrade.rst
@@ -30,6 +30,16 @@ When customizing renderers, these methods' parameters are changed:
     -    table_cell(self, text, align=None, is_head=False)
     +    table_cell(self, text, align=None, head=False)
 
+For plugins:
+
+.. code-block:: diff
+
+    - abbr(self, key, definition)
+    + abbr(self, text: str, title: str)
+
+    - task_list_item(self, text: str, level: int, checked: bool)
+    + task_list_item(self, text: str, checked: bool)
+
 AstRenderer
 ~~~~~~~~~~~