Opened 2 years ago

Closed 2 years ago

Last modified 2 years ago

#20612 closed Uncategorized (fixed)

Missing text in documentation of class-based views.

Reported by: ndokos@… Owned by: nobody
Component: Documentation Version: 1.5
Severity: Normal Keywords: documentation class-based views extra context
Cc: Triage Stage: Accepted
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: yes UI/UX: no

Description

In docs/topics/class-based-views/generic-display.txt, in the section entitled "Adding extra context", there is a question mark missing at the end of the first paragraph and there seems to be some connecting text missing between the first and second paragraphs: as it stands now, the text does not make sense:

<quote>
Often you simply need to present some extra information beyond that
provided by the generic view. For example, think of showing a list of
all the books on each publisher detail page. The
:class:~django.views.generic.detail.DetailView generic view provides
the publisher to the context, but how do we get additional information
in that template.

However, there is; you can subclass
:class:~django.views.generic.detail.DetailView and provide your own
implementation of the get_context_data method.

</quote>

Change History (3)

comment:1 Changed 2 years ago by bmispelon

  • Easy pickings set
  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset
  • Triage Stage changed from Unreviewed to Accepted

comment:2 Changed 2 years ago by Baptiste Mispelon <bmispelon@…>

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

In b53ed5ac55d5881f129c4921199af355e2b13565:

Fixed #20612 -- Fixed incorrect wording in CBV documentation

Thanks to ndokos for the report.

comment:3 Changed 2 years ago by Baptiste Mispelon <bmispelon@…>

In ee8996d8a6f8fc462a6e912bcf0cf80530704ab4:

[1.5.x] Fixed #20612 -- Fixed incorrect wording in CBV documentation

Thanks to ndokos for the report.

Backport of b53ed5ac55d5881f129c4921199af355e2b13565 from master.

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