[Django] #20975: Fix incorrect markup of committers list (and possibly other docs lists)

7 views
Skip to first unread message

Django

unread,
Aug 26, 2013, 8:12:17 AM8/26/13
to django-...@googlegroups.com
#20975: Fix incorrect markup of committers list (and possibly other docs lists)
-------------------------------+--------------------
Reporter: EvilDMP | Owner: nobody
Type: Uncategorized | Status: new
Component: Documentation | Version: master
Severity: Normal | Keywords:
Triage Stage: Unreviewed | Has patch: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------+--------------------
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 [http://www.djangocon.us/schedule/presentation/7/ Don't be
afraid to commit tutorial] and the sprints at [http://djangocon.us/
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.

--
Ticket URL: <https://code.djangoproject.com/ticket/20975>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

Django

unread,
Aug 26, 2013, 2:04:51 PM8/26/13
to django-...@googlegroups.com
#20975: Fix incorrect markup of committers list (and possibly other docs lists)
--------------------------------------+------------------------------------
Reporter: EvilDMP | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0

Easy pickings: 1 | UI/UX: 0
--------------------------------------+------------------------------------
Changes (by claudep):

* needs_docs: => 0
* needs_better_patch: => 0
* type: Uncategorized => Cleanup/optimization
* needs_tests: => 0
* stage: Unreviewed => Accepted


--
Ticket URL: <https://code.djangoproject.com/ticket/20975#comment:1>

Django

unread,
Aug 27, 2013, 6:12:10 AM8/27/13
to django-...@googlegroups.com
#20975: Fix incorrect markup of committers list (and possibly other docs lists)
--------------------------------------+------------------------------------
Reporter: EvilDMP | Owner: EvilDMP
Type: Cleanup/optimization | Status: assigned
Component: Documentation | Version: master

Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0

Easy pickings: 1 | UI/UX: 0
--------------------------------------+------------------------------------
Changes (by EvilDMP):

* owner: nobody => EvilDMP
* status: new => assigned


--
Ticket URL: <https://code.djangoproject.com/ticket/20975#comment:2>

Django

unread,
Sep 2, 2013, 3:45:16 PM9/2/13
to django-...@googlegroups.com
#20975: Fix incorrect markup of committers list (and possibly other docs lists)
--------------------------------------+------------------------------------
Reporter: EvilDMP | Owner: EvilDMP
Type: Cleanup/optimization | Status: assigned
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: afraid-to-commit | Triage Stage: Accepted

Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0

Easy pickings: 1 | UI/UX: 0
--------------------------------------+------------------------------------
Changes (by EvilDMP):

* keywords: => afraid-to-commit


--
Ticket URL: <https://code.djangoproject.com/ticket/20975#comment:3>

Django

unread,
Sep 6, 2013, 10:54:30 AM9/6/13
to django-...@googlegroups.com
#20975: Fix incorrect markup of committers list (and possibly other docs lists)
-------------------------------------+-------------------------------------
Reporter: EvilDMP | Owner: anonymous
Type: | Status: assigned
Cleanup/optimization | Version: master
Component: Documentation | Resolution:
Severity: Normal | Triage Stage: Accepted
Keywords: afraid-to-commit | Needs documentation: 0
Has patch: 0 | Patch needs improvement: 0
Needs tests: 0 | UI/UX: 0
Easy pickings: 1 |
-------------------------------------+-------------------------------------
Changes (by anonymous):

* owner: EvilDMP => anonymous


--
Ticket URL: <https://code.djangoproject.com/ticket/20975#comment:4>

Django

unread,
Sep 6, 2013, 10:57:44 AM9/6/13
to django-...@googlegroups.com
#20975: Fix incorrect markup of committers list (and possibly other docs lists)
--------------------------------------+------------------------------------
Reporter: EvilDMP | Owner: animan1
Type: Cleanup/optimization | Status: assigned
Component: Documentation | Version: master

Severity: Normal | Resolution:
Keywords: afraid-to-commit | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0

Easy pickings: 1 | UI/UX: 0
--------------------------------------+------------------------------------
Changes (by animan1):

* owner: anonymous => animan1


--
Ticket URL: <https://code.djangoproject.com/ticket/20975#comment:5>

Django

unread,
Sep 6, 2013, 1:04:38 PM9/6/13
to django-...@googlegroups.com
#20975: Fix incorrect markup of committers list (and possibly other docs lists)
--------------------------------------+------------------------------------
Reporter: EvilDMP | Owner: animan1
Type: Cleanup/optimization | Status: closed
Component: Documentation | Version: master
Severity: Normal | Resolution: fixed

Keywords: afraid-to-commit | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0

Easy pickings: 1 | UI/UX: 0
--------------------------------------+------------------------------------
Changes (by Tim Graham <timograham@…>):

* status: assigned => closed
* resolution: => fixed


Comment:

In [changeset:"b69d1eac641433dba3d6e505261f9ad7db384bd7"]:
{{{
#!CommitTicketReference repository=""
revision="b69d1eac641433dba3d6e505261f9ad7db384bd7"
Fixed #20975 -- Fixed identation in docs/internals/committers.txt

Thanks EvilDMP for the report.
}}}

--
Ticket URL: <https://code.djangoproject.com/ticket/20975#comment:6>

Reply all
Reply to author
Forward
0 new messages