Opened 15 years ago

Closed 12 years ago

#11817 closed Bug (worksforme)

Incorrect document structures in django-documentation

Reported by: Axel Rau Owned by: nobody
Component: contrib.admindocs Version: 1.1
Severity: Normal Keywords:
Cc: josh@… Triage Stage: Accepted
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no

Description

Some templates of the django documentation respectively the contents contain incorrect document structures - e.g.


Template tag documentation

<h4><p>Force autoescape behaviour for this block.</p></h4>
<p/>

The h4 should not contain a p

The single p after the h4 should be removed

Change History (8)

comment:1 by joshuajonah, 15 years ago

Cc: josh@… added

If you have time, can you link the the problem pages?

comment:2 by Kellen, 14 years ago

That line is from http://code.djangoproject.com/browser/django/trunk/django/template/defaulttags.py#L436 but I don't see the text anywhere in the normal documentation.

comment:3 by Tim Graham, 14 years ago

Component: DocumentationContrib apps

This is actually from "Template tag documentation" page (/admin/doc/tags/) generated by the django.contrib.admindocs.

comment:4 by Russell Keith-Magee, 14 years ago

Triage Stage: UnreviewedAccepted

comment:5 by Bas Peschier, 13 years ago

With all the cleaning going on and new versions of docutils, this seems to have gone away? I cannot reproduce it anymore.

comment:6 by Gabriel Hurley, 13 years ago

Component: Contrib appsDocumentation

comment:7 by Julien Phalip, 13 years ago

Component: Documentationcontrib.admindocs
Easy pickings: unset
Severity: Normal
Type: Bug

comment:8 by Aymeric Augustin, 12 years ago

Resolution: worksforme
Status: newclosed
UI/UX: unset

I confirm this bug no longer exists.

Here's the current output corresponding to the bug report:

<h1>Template tag documentation</h1>

<div id="content-main">


<div class="module">
    <h2>Built-in tags</h2>
    
    
    <h3 id="built_in-autoescape">autoescape</h3>
    <h4>Force autoescape behavior for this block.
</h4>
    
    <hr />
    
    <h3 id="built_in-block">block</h3>
    <h4>Define a block that can be overridden by child templates.
</h4>
    
    <hr />
    
    <h3 id="built_in-comment">comment</h3>
    <h4>Ignores everything between {% comment %} and {% endcomment %}.
</h4>
    
    <hr />

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