sphinx-doc/sphinx

opening double quote followed by punctuation character converted to curly right quotation mark

Open

#580 opened on Jan 2, 2015

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Python (1,985 forks)batch import
builder:htmlhelp wantedtype:bug

Repository metrics

Stars
 (5,625 stars)
PR merge metrics
 (Avg merge 10d 11h) (11 merged PRs in 30d)

Description

Sphinx 1.0.5 incorrectly converts e.g.

   Is there an equivalent of C’s "?:" ternary operator?

to

   Is there an equivalent of C’s ”?:” ternary operator?

(Example taken from http://docs.python.org/dev/faq/programming.html#is-there-an-equivalent-of-c-s-ternary-operator )

Contributor guide

Research direction
Locate the smart quotes transformation in Sphinx's typography module and examine the logic that converts opening double quotes to curly right quotation marks when followed by punctuation. Debug the regex pattern or string replacement to correct the behavior.
Tech stack
python
Domain
documentation
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
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
PythonSphinx internals
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60