Code

Opened 3 years ago

Closed 2 years ago

#14836 closed Bug (fixed)

Improve semantics of docs:

Reported by: cogat Owned by: cogat
Component: *.djangoproject.com Version: 1.2
Severity: Normal Keywords: sprintdec2010
Cc: Triage Stage: Accepted
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no

Description

Everything is mostly good, except:

  • #14835 and other things that can be fixed in the doc source file
  • 'This document describes Django 1.2. For development docs, go here.' is an <h2>. It should be a <p>.
  • This one came up when viewing the docs with site CSS turned off. Admonition titles are 'p.admonition-title'. I suggest including 'strong', rather than a heading, since it isn't context-free enough to be a heading (the HTML5 tag would be <aside>), but it needs to be higher up the chain than plain text.

I will patch these when we establish the way to update djangoproject's base.css file (discussion at http://groups.google.com/group/django-developers/browse_thread/thread/2d14c16358069b37)

Attachments (0)

Change History (5)

comment:1 Changed 3 years ago by gabrielhurley

  • Component changed from Documentation to Django Web site
  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset
  • Triage Stage changed from Unreviewed to Accepted

FWIW, these are all more about the django website than the documentation, so I'm re-categorizing.

comment:2 Changed 3 years ago by jaddison

  • Severity set to Normal
  • Type set to Bug

comment:3 Changed 2 years ago by aaugustin

  • UI/UX unset

Change UI/UX from NULL to False.

comment:4 Changed 2 years ago by aaugustin

  • Easy pickings unset

Change Easy pickings from NULL to False.

comment:5 Changed 2 years ago by aaugustin

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

AFAICT no patch was actually written, however:

  • #14835 was fixed.
  • the string 'This document describes Django 1.2. For development docs, go here.' apparently no longer exists on the website. At least I didn't find 'go here' in the source.
  • p.admonition-title is generated by Sphinx, and that's very hard to change.

Please re-open the ticket if I've missed something.

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.