Opened 2 years ago

Closed 2 years ago

Last modified 2 years ago

#20262 closed Bug (fixed)

"Article" in the note should be "Author"

Reported by: anonymous Owned by: mossplix
Component: Documentation Version: 1.4
Severity: Normal Keywords:
Cc: bmispelon@… Triage Stage: Ready for checkin
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: yes UI/UX: no

Description

There's a note in the beginning of the generic editing views page (https://docs.djangoproject.com/en/dev/ref/class-based-views/generic-editing/) that reads as follows:

Some of the examples on this page assume that an Article model has been defined as follows in myapp/models.py:
...
class Author(models.Model):
...

The "Article" should probably be "Author", since the model's name in the note and in following examples is "Author".

Attachments (1)

article_to_author.diff (561 bytes) - added by mossplix 2 years ago.
patch for ticket fix

Download all attachments as: .zip

Change History (6)

comment:1 Changed 2 years ago by bmispelon

  • Cc bmispelon@… added
  • Easy pickings set
  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset
  • Triage Stage changed from Unreviewed to Accepted

Indeed it should be.

For anyone who would like to try their hand at it, the file to change is docs/ref/class-based-views/generic-editing.txt.

Thanks for the report.

comment:2 Changed 2 years ago by mossplix

  • Owner changed from nobody to mossplix
  • Status changed from new to assigned

Changed 2 years ago by mossplix

patch for ticket fix

comment:3 Changed 2 years ago by bmispelon

  • Has patch set
  • Triage Stage changed from Accepted to Ready for checkin
  • Type changed from Uncategorized to Bug

Patch looks good. I'm marking this as "Ready for checkin".

Thank you for your contribution.

comment:4 Changed 2 years ago by Simon Charette <charette.s@…>

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

In b0bbccf6307b0f4914eabd520467bc159d25923f:

Fixed #20262 -- Replaced a reference to the wrong model in the CBV doc.

Thanks to mossplix for the review and bmispelon for the review.

comment:5 Changed 2 years ago by Simon Charette <charette.s@…>

In 56f6348c5071c1a1aaea989a16d5055d24ab6740:

[1.5.x] Fixed #20262 -- Replaced a reference to the wrong model in the CBV doc.

Thanks to mossplix for the review and bmispelon for the review.

Backport of b0bbccf from master.

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