Opened 11 years ago

Closed 11 years ago

Last modified 10 years ago

#20852 closed Bug (fixed)

Apostrophes after code markup render as left quote

Reported by: icedream91@… Owned by: Dominic Rodger
Component: Documentation Version: dev
Severity: Normal Keywords:
Cc: internet@… Triage Stage: Accepted
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: yes UI/UX: no

Description

In page https://docs.djangoproject.com/en/dev/ref/settings/ , there is a typo in sentence "You should do that in directories that will be found by staticfiles‘s finders": the single quotes in this sentence should be"'".

Thanks.

Change History (8)

comment:1 by Dominic Rodger, 11 years ago

Cc: internet@… added
Triage Stage: UnreviewedAccepted

I can't submit a pull request right now, but it's a trivial fix - just use "’" (U+2019) instead of "'" (see http://docutils.sourceforge.net/0.7/docs/ref/rst/restructuredtext.html).

comment:2 by Dominic Rodger, 11 years ago

Has patch: set
Owner: changed from nobody to Dominic Rodger
Status: newassigned

Actually, I can submit a pull request: https://github.com/django/django/pull/1429.

comment:3 by Tim Graham, 11 years ago

Patch needs improvement: set

It would be nice if there were a simpler solution that didn't require entering unicode characters in the docs, but an unresolved sphinx ticket is all I could find. That said, if we go with this solution, we should fix all instances of this in one go.

comment:4 by Tim Graham, 11 years ago

Summary: Docs TypoApostrophes after code markup render as left quote

comment:5 by Dominic Rodger, 11 years ago

To be clear - if I send a pull request which fixes all the instances of this in the docs using the approach in my previous pull request (which just fixes the one mentioned in the original report), will it be accepted? I'm very happy to do that, just want to make sure I'm not wasting my time here.

I'm not sure I'll be able to fix up the quotes parsing (though that approach might be worth looking at).

comment:6 by Dominic Rodger, 11 years ago

Patch needs improvement: unset

Updated pull request at https://github.com/django/django/pull/1439 - I think that fixes all the instances of this.

p.s. I assume unsetting "Patch needs improvement" is the correct thing to do here, since I think I've addressed the issue with the original patch, that it was insufficiently comprehensive, do let me know if that's the wrong thing to do so I know for another time.

comment:7 by Tim Graham <timograham@…>, 11 years ago

Resolution: fixed
Status: assignedclosed

In c33d1ca1d98003de29cdecb6080b52c5c52139bd:

Fixed #20852 - Fixed incorrectly generated left quotes in docs.

Sphinx generates left single quotes for apostrophes after
code markup, when right single quotes are required. The
easiest way to fix this is just by inserting the unicode
character for a right single quote.

Instances of the problem were found by looking for
">&#8216;" in the generated HTML.

comment:8 by Baptiste Mispelon <bmispelon@…>, 10 years ago

In a9c50fccf295d3ff8915588cd6442f1c70f1af9a:

[1.6.x] Fixed #20852 - Fixed incorrectly generated left quotes in docs.

Sphinx generates left single quotes for apostrophes after
code markup, when right single quotes are required. The
easiest way to fix this is just by inserting the unicode
character for a right single quote.

Instances of the problem were found by looking for
">&#8216;" in the generated HTML.

Backport of c33d1ca1d98003de29cdecb6080b52c5c52139bd from master.

Note: See TracTickets for help on using tickets.
Back to Top