Opened 5 years ago

Closed 5 years ago

Last modified 5 years ago

#20565 closed New feature (fixed)

Generic view descriptions should give template examples

Reported by: david.reitter@… Owned by: Baptiste Darthenay
Component: Documentation Version: master
Severity: Normal Keywords:
Cc: bmispelon@…, Baptiste Darthenay Triage Stage: Accepted
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: yes UI/UX: no


When reading the docs for generic views, I wonder what the templates should like like.

It does not seem like standard templates are provided (why not?), but as a minimum, the documentation should give an example of a template for each view class.

The template variables are idiosyncratic w.r.t. the view class, e.g., the ListView defines 'object_list' as a variable. So why not give this template example:

{% block content %}
        {% for o in object_list %}
           <tr><td>{{ o }}</td><td><a href="{% url 'exam_update' %}">edit</a>&nbsp;&nbsp;<a href="{% url 'exam_delete' %}">del</a></td></tr>
        {% endfor %}
{% endblock %}

Right now, I am looking for how to correctly implement the delete confirmation template.

Change History (6)

comment:1 Changed 5 years ago by Baptiste Mispelon

Cc: bmispelon@… added
Triage Stage: UnreviewedAccepted
Type: UncategorizedNew feature

Seeing as we're already providing an example and for most views, I think it makes sense to include an example template when it makes sense.

The only example template I could find was in

comment:2 Changed 5 years ago by Baptiste Darthenay

Cc: Baptiste Darthenay added
Owner: changed from nobody to Baptiste Darthenay
Status: newassigned

comment:3 Changed 5 years ago by Baptiste Darthenay

comment:4 Changed 5 years ago by Baptiste Darthenay

Has patch: set

comment:5 Changed 5 years ago by Baptiste Darthenay <baptiste+github@…>

Resolution: fixed
Status: assignedclosed

In 81545940c68de0d1235a2fb50e61b8619f17a3e3:

Fixed #20565 -- Added template examples for GCBV.

Thanks to David Reitter for the report,
and to Marc Tamlyn and Baptiste Mispelon for the review.

comment:6 Changed 5 years ago by Marc Tamlyn <marc.tamlyn@…>

In f6567578887b7cc4efb0006ac4a3a5ba7a1c2cc7:

Merge pull request #1271 from batisteo/ticket-20565

Fixed #20565 -- Added template examples for GCBV.

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