Incorect quote marks in code section-headers in PDF version of docs

[icedream91]

BPO	18177
Nosy	@akuchling, @birkenfeld, @ezio-melotti, @bitdancer

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = <Date 2013-10-12.16:26:00.036>
created_at = <Date 2013-06-10.02:03:00.730>
labels = ['type-feature', 'invalid', 'docs']
title = 'Incorect quote marks in code section-headers in PDF version of docs'
updated_at = <Date 2013-10-12.16:26:00.035>
user = 'https://bugs.python.org/icedream91'

bugs.python.org fields:

activity = <Date 2013-10-12.16:26:00.035>
actor = 'georg.brandl'
assignee = 'docs@python'
closed = True
closed_date = <Date 2013-10-12.16:26:00.036>
closer = 'georg.brandl'
components = ['Documentation']
creation = <Date 2013-06-10.02:03:00.730>
creator = 'icedream91'
dependencies = []
files = []
hgrepos = []
issue_num = 18177
keywords = []
message_count = 6.0
messages = ['190882', '190908', '190910', '199354', '199433', '199591']
nosy_count = 7.0
nosy_names = ['akuchling', 'georg.brandl', 'ezio.melotti', 'r.david.murray', 'docs@python', 'tshepang', 'icedream91']
pr_nums = []
priority = 'normal'
resolution = 'not a bug'
stage = None
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue18177'
versions = ['Python 2.7', 'Python 3.3', 'Python 3.4']

[icedream91]

In library.pdf file(Release 3.3.2, June 09, 2013), I found a typo in page 149: I think the quotation marks are wrong in "datetime.isoformat(sep=’T’)" sentence, they should both be "'".
But it's right in online documents (http://docs.python.org/3/library/datetime.html#datetime.datetime.isoformat).

Thanks.

[akuchling]

Confirmed. I think this is a general typographic issue in the PDF documentation. If I cut-and-paste the datetime.isoformat(sep='T') line from the PDF, the single quotes are pasted as U+2019 RIGHT SINGLE QUOTE.

Looking at the library.tex file built by "make pdflatex", it contains the ASCII single quotes, so LaTeX is responsible for turning the quotes into smart quotes.

I don't know if this is worth fixing and can see arguments both ways. The smart quotes are readable and I doubt a reader will be confused and try to actually type them in their source code. OTOH it's annoying that cut-and-pasting code from the PDFs won't work.

[bitdancer]

I presume that tex doesn't do quote-transformation on code blocks (it is not really smart quotes, since IIRC in tex you actually have to specify ` and ' in the correct places yourself). So perhaps the problem is that the function headers &c aren't being properly marked up as code in the latex output engine of Sphinx?

[tshepang]

A work-around: http://stackoverflow.com/a/16164658/321731.

[ezio-melotti]

Should this be moved to the Sphinx bug tracker?

[birkenfeld]

Yes, there is already one or two issues there (e.g. number 1239).