add note, closes issue #40

jamesturk · Oct 6, 2016 · 3510f17 · 3510f17
1 parent 363c88f
commit 3510f17
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/README.rst b/README.rst
@@ -139,6 +139,13 @@ Examples
     )
     MarkupField(markup_choices=CUSTOM_RENDERERS)
 
+.. note::
+    When using ``markdown``, be sure to use ``markdown.markdown`` and not
+    the ``markdown.Markdown`` class, the class requires an explicit ``reset``
+    to function properly in some cases.  (See [issue #40](https://github.com/jamesturk/django-markupfield/issues/40)
+    for details.)
+
+
 Accessing a MarkupField on a model
 ----------------------------------