Opened 8 years ago

Closed 8 years ago

Last modified 5 years ago

#8696 closed (fixed)

Online docs using incorrect apostrophe character

Reported by: jjackson Owned by: Jacob
Component: Documentation Version: 1.0-beta
Severity: Keywords:
Cc: Triage Stage: Accepted
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: UI/UX:

Description (last modified by Ramiro Morales)

The online docs at http://docs.djangoproject.com/en/dev/intro/tutorial02/#intro-tutorial02
are using incorrect characters for apostrophes. The example url patterns

urlpatterns = patterns(‘’,
    # Example:
    # (r’^{{ project_name }}/’, include(‘{{ project_name }}.foo.urls’)),

    # Uncomment the next line to enable admin documentation:
    # (r’^admin/doc/’, include(‘django.contrib.admindocs.urls’)),

    # Uncomment the next line to enable the admin:
    (r’^admin/(.*)’, admin.site.root),
)

cannot be cut and pasted because they are using ’ instead of ' to delimit their strings. You'll notice that the code color-coding is incorrect. A search for ".. parsed-literal::" in the source turned up five hits; these four files show this problem with delimiters:

docs/intro/tutorial02.txt
docs/howto/deployment/modpython.txt
docs/howto/custom-template-tags.txt
docs/howto/apache-auth.txt

It looks like parsed-literal is the wrong tag to use here.

Attachments (1)

t8696-r8782.diff (765 bytes) - added by Ramiro Morales 8 years ago.
Patch that stops SmatyPants from messing with parsed-literal blocks

Download all attachments as: .zip

Change History (7)

comment:1 Changed 8 years ago by Jacob

Component: UncategorizedDocumentation
Owner: changed from nobody to Jacob
Status: newassigned
Triage Stage: UnreviewedAccepted

comment:2 Changed 8 years ago by Ramiro Morales

Description: modified (diff)

reformatted description

comment:3 Changed 8 years ago by Ramiro Morales

Actually, the guilty here is SmartyPants, parsed-literal is innocent.

Changed 8 years ago by Ramiro Morales

Attachment: t8696-r8782.diff added

Patch that stops SmatyPants from messing with parsed-literal blocks

comment:4 Changed 8 years ago by Ramiro Morales

Has patch: set

comment:5 Changed 8 years ago by Jacob

Resolution: fixed
Status: assignedclosed

(In [8875]) Fixed the documentation HTML writer to not apply smartypants to literal blocks. Fixes #8696; thanks, ramiro.

comment:6 Changed 5 years ago by Jacob

milestone: 1.0

Milestone 1.0 deleted

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