Opened 3 years ago

Closed 3 years ago

Last modified 3 years ago

#21264 closed Bug (fixed)

RST error in docs at /dev/topics/class-based-views

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

Description

See: https://docs.djangoproject.com/en/dev/topics/class-based-views/#subclassing-generic-views

There's some text in the file /docs/topics/class-based-views/index.html that renders as: "~django.views.generic.base.TemplateView is a class, not a function". This is obviously some incorrectly marked up RST.

I've marked this ticket as especially suitable for first-time committers or people following the Don't be afraid to commit tutorial. If you're tackling this ticket, please don't hesitate to ask me for guidance if you'd like any, either here or on the Django IRC channels, where I can be found as EvilDMP.

Change History (5)

comment:1 Changed 3 years ago by Tim Graham

Component: UncategorizedDocumentation
Triage Stage: UnreviewedAccepted
Type: UncategorizedBug

There's a similar instance in topics/http/shortcuts.html: "A model: the model’s :meth:`~django.db.models.Model.get_absolute_url()"

comment:2 Changed 3 years ago by Bouke Haarsma

Has patch: set

Tackled this as my first Django PR: https://github.com/django/django/pull/1735

comment:3 Changed 3 years ago by Tim Graham <timograham@…>

Resolution: fixed
Status: newclosed

In 8fc63087f6ad888b68dff17ee0c527774332d932:

Fixed #21264 -- Incorrect RST usage in docs

comment:4 Changed 3 years ago by Tim Graham <timograham@…>

In e3c8db61f3d1e86ac523fc76095d7f3dd1cbe760:

[1.6.x] Fixed #21264 -- Incorrect RST usage in docs

Backport of 8fc63087f6 from master

comment:5 Changed 3 years ago by Tim Graham <timograham@…>

In b268488806bd0cbfd29a874069ece89f61585935:

[1.5.x] Fixed #21264 -- Incorrect RST usage in docs

Backport of 8fc63087f6 from master

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