jgm/pandoc

some RST paragraphs are written out like lists

Open

#4,422 opened on Mar 1, 2018

View on GitHub
 (5 comments) (0 reactions) (0 assignees)Haskell (44,133 stars) (3,850 forks)batch import
format:RSTgood first issuewriter

Description

paragraphs starting with the same prefix of a list will have the semantics of a list when written by pandoc, and can be represented as paragraphs by escaping the starting character. from the doc:

If a single-line paragraph begins with text identical to an enumerator ("A.", "1.", "(b)", "I)", etc.), the first character will have to be escaped in order to have the line parsed as an ordinary paragraph:

\A. Einstein was a really smart dude.

Contributor guide

Tech stack
None
Domain
backend
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Familiarity with pandoc's RST readerBasic Haskell knowledge
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
Examine the RST reader implementation in pandoc, likely in src/Text/Pandoc/Readers/RST.hs. The issue describes that paragraphs beginning with text identical to an enumerator (e.g., 'A.', '1.') are incorrectly parsed as lists. The fix involves escaping the first character of such paragraphs to ensure they are treated as ordinary paragraphs. Refer to the docutils documentation at http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#enumerated lists for the exact escaping rules.
some RST paragraphs are written out like lists · jgm/pandoc#4422 | Good First Issue