Code

Opened 6 years ago

Closed 6 years ago

Last modified 3 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)

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 6 years ago.
Patch that stops SmatyPants from messing with parsed-literal blocks

Download all attachments as: .zip

Change History (7)

comment:1 Changed 6 years ago by jacob

  • Component changed from Uncategorized to Documentation
  • Needs documentation unset
  • Needs tests unset
  • Owner changed from nobody to jacob
  • Patch needs improvement unset
  • Status changed from new to assigned
  • Triage Stage changed from Unreviewed to Accepted

comment:2 Changed 6 years ago by ramiro

  • Description modified (diff)

reformatted description

comment:3 Changed 6 years ago by ramiro

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

Changed 6 years ago by ramiro

Patch that stops SmatyPants from messing with parsed-literal blocks

comment:4 Changed 6 years ago by ramiro

  • Has patch set

comment:5 Changed 6 years ago by jacob

  • Resolution set to fixed
  • Status changed from assigned to closed

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

comment:6 Changed 3 years ago by jacob

  • milestone 1.0 deleted

Milestone 1.0 deleted

Add Comment

Modify Ticket

Change Properties
<Author field>
Action
as closed
as The resolution will be set. Next status will be 'closed'
The resolution will be deleted. Next status will be 'new'
Author


E-mail address and user name can be saved in the Preferences.

 
Note: See TracTickets for help on using tickets.