jpt/django-markupfield
1
0
Fork 0
Code Issues 2 Pull requests Activity

Markdown footnote reset issue #40

New issue
Closed
opened 2016-08-16 13:54:00 +02:00 by nzp · 1 comment
nzp commented 2016-08-16 13:54:00 +02:00 (Migrated from github.com)
Copy link

This is probably a documentation issue more than anything else. When configuring Markdown, the first instinct is probably to use a configured markdown.Markdown instance in MARKUP_FIELD_TYPES. However, Markdown instances need to be explicitly reset (Markdown.reset()) after rendering to avoid issues such as this waylan/Python-Markdown#401 (I tripped on this, so here I am).

markdown.markdown handles this automatically, so the proper way, probably, to go about this is to use django.utils.functional.curry (or own similar function) to wrap it (like you do when you're adding Pygments extension) and add configuration in MARKUP_FIELD_TYPES. This should probably be mentioned in documentation.

This is probably a documentation issue more than anything else. When configuring Markdown, the first instinct is probably to use a configured `markdown.Markdown` instance in `MARKUP_FIELD_TYPES`. However, Markdown instances need to be explicitly reset (`Markdown.reset()`) after rendering to avoid issues such as this waylan/Python-Markdown#401 (I tripped on this, so here I am). `markdown.markdown` handles this automatically, so the proper way, probably, to go about this is to use `django.utils.functional.curry` (or own similar function) to wrap it (like you do when you're adding Pygments extension) and add configuration in `MARKUP_FIELD_TYPES`. This should probably be mentioned in documentation.
jamesturk commented 2016-08-23 17:22:36 +02:00 (Migrated from github.com)
Copy link

thanks for this report, had no idea! I'll look at getting a fix in next time I have a few spare cycles

thanks for this report, had no idea! I'll look at getting a fix in next time I have a few spare cycles
👍 1
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
main
dependabot/add-v2-config-file
1.5.x
2.0.1
2.0.0
1.5.1
1.5.0
1.4.3
1.4.2
1.4.1
1.4.0
1.3.5
1.3.4
1.3.3
1.3.2
1.3.0
1.2.1
1.2.0
1.1.1
1.0.2
1.0.1
1.0.0b2
1.0.0b
1.0.0a2
1.0.0a
0.3.1
0.3.0
0.2.0
0.1.2
0.1.1
0.1.0
Labels
Clear labels
No items
No labels
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
jpt/django-markupfield#40
No description provided.