trentm / trentm/python-markdown2

Bug in footnote handling.

Open
#250 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
2.8k
Forks
459
Avg merge
2d 19h
Merged PRs (30d)
4

Description

If there is a single space on the line following a footnote, the footnote regex gets a bit
confused.

import markdown2

text = '''
Here is some markdown with a footnote[^myfootnote] embedded within it.

[^myfootnote]: I define the footnote here on 
    multiple lines but the line below contains *one* space but looks blank
 

'''
markdowner = markdown2.Markdown()
markdowner.convert(text)

This produces the following html output.

<p>Here is some markdown with a footnote[^myfootnote] embedded 
within it.</p>\n\n<pre><code>multiple lines but the line below 
contains *one* space but looks blank\n</code></pre>\n'

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the Python reproduction in the issue and trace markdown2's footnote parsing entry point using the supplied input. Check how a line containing one space is handled after a multi-line footnote. Done means the footnote remains parsed as a footnote and the generated HTML no longer places its continuation in a code block.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.