Code

Opened 3 years ago

Closed 3 years ago

Last modified 3 years ago

#14835 closed (fixed)

Improper indentation for docs/ref/contrib/admin/index.txt

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

Description

In docs/ref/contrib/admin/index.txt, the attributes for ModelAdmin aren't indented. The effect in the resulting HTML is that <dt> elements are created with no <dd> elements. Instead, there is an empty <dt>, the enclosing <dl> is terminated and the definition appears in the following <p>. For InlineModelAdmin, the markup is correct, but the styling indents the dt, which I guess looks ugly to some.

Both problems are addressed by modifying djangoproject CSS so that <dt> does not appear indented, and also to fix the markup so that <dt>s are populated. I'll do so once we establish a way to update djangoproject's css (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 cogat

  • milestone 1.3 deleted
  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset

comment:2 Changed 3 years ago by gabrielhurley

  • milestone set to 1.3
  • Owner changed from cogat to gabrielhurley
  • Status changed from new to assigned
  • Summary changed from Indents for descriptions of documentation attributes to Improper indentation for docs/ref/contrib/admin/index.txt
  • Triage Stage changed from Unreviewed to Accepted

I've noted it on other tickets before, but this is a reST markup problem, not a CSS problem. Basically, it's a lack of proper indentation in the file such that the <dd> elements aren't created. There are a lot of older chunks of the docs that have this problem.

When the markup is correct the indentation of the elements is also correct. I prefer fixing the markup (the real problem) to applying CSS hacks to correct for bad markup.

I'm changing this ticket to be about fixing the markup in that file, and will commit the fix to close it momentarily.

comment:3 Changed 3 years ago by gabrielhurley

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

(In [14830]) Fixed #14835 -- Corrected a lack of indentation in the reST markup for docs/ref/contrib/admin/index.txt and reflowed the text accordingly. Thanks to cogat for the report.

comment:4 Changed 3 years ago by lukeplant

In [15620]:

[1.2.X] Fixed #14835 -- Corrected a lack of indentation in the reST markup for docs/ref/contrib/admin/index.txt and reflowed the text accordingly.

Thanks to cogat for the report.

Backport of [14830] from trunk - approximate, because other changes have
made it very hard to do exactly.

comment:5 Changed 3 years ago by jacob

  • milestone 1.3 deleted

Milestone 1.3 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.