#20975 closed Cleanup/optimization (fixed)

Fix incorrect markup of committers list (and possibly other docs lists)

Reported by: EvilDMP Owned by: animan1
Component: Documentation Version: master
Severity: Normal Keywords: afraid-to-commit
Cc: Triage Stage: Accepted
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: yes UI/UX: no

Description

The list of Django committers - https://docs.djangoproject.com/en/dev/internals/committers/ - should be three HTML definition lists. In fact, it's dozens of definition lists, of the form:

<dl>
    <dt>Name</dt>
    <dd>Description</dd>
</dl>
<dl>
    <dt>Name</dt>
    <dd>Description</dd>
</dl>
[... and so on]

This is because it is marked up incorrectly.

Incorrect:

Marc Tamlyn
    Marc currently works at `Incuna Ltd`_, [...]

.. _Incuna Ltd: http://incuna.com/

Correct:

Marc Tamlyn
    Marc currently works at `Incuna Ltd`_, [...]

    .. _Incuna Ltd: http://incuna.com/

The incorrect form places the reference for the links in the previous block at the start of the line, rather than indented to the same column as the block. This causes a new definition list to be started the next time the markup for a definition term (i.e. <dt>Name</dt>) is encountered.

It's quite possible that the same problem occurs elsewhere in the documents, so it would be worth checking.

I would like to reserve this ticket for first-time committers who take part in the Don't be afraid to commit tutorial and the sprints at DjangoCon US 2013 in September.

However, if you want to tackle this ticket before then, please don't hesitate. Feel free to re-assign it to yourself and do whatever you like to it.

Change History (6)

comment:1 Changed 21 months ago by claudep

  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset
  • Triage Stage changed from Unreviewed to Accepted
  • Type changed from Uncategorized to Cleanup/optimization

comment:2 Changed 21 months ago by EvilDMP

  • Owner changed from nobody to EvilDMP
  • Status changed from new to assigned

comment:3 Changed 21 months ago by EvilDMP

  • Keywords afraid-to-commit added

comment:4 Changed 21 months ago by anonymous

  • Owner changed from EvilDMP to anonymous

comment:5 Changed 21 months ago by animan1

  • Owner changed from anonymous to animan1

comment:6 Changed 21 months ago by Tim Graham <timograham@…>

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

In b69d1eac641433dba3d6e505261f9ad7db384bd7:

Fixed #20975 -- Fixed identation in docs/internals/committers.txt

Thanks EvilDMP for the report.

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