Opened 3 years ago

Closed 2 years ago

Last modified 2 years ago

#22154 closed Cleanup/optimization (fixed)

Rename Class Based Generic Views to Built-in Class Based Views

Reported by: buyittoday@… Owned by: nobody
Component: Documentation Version: 1.6
Severity: Normal Keywords: Class Based Views
Cc: Triage Stage: Accepted
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no

Description

Class Based Generic Views should be renamed to 'Built-in Class Based Views' or 'Built-in Class Views' to avoid a confusion with the implementation of a user defined Class Based View. The names Class Based Generic Views and Class Based Views which are meant to mean different things generates much confusion in the django community due to their subtle difference in naming scheme. This subtly impedes meaningful discussions on the subject. Nomenclature is an important part of any system in science and unless a thing or idea is clearly identified it cannot not be clearly communicated.

Attachments (1)

22154.diff (1.1 KB) - added by Tim Graham 2 years ago.

Download all attachments as: .zip

Change History (7)

comment:1 Changed 3 years ago by Tim Graham

Component: UncategorizedDocumentation
Triage Stage: UnreviewedAccepted
Type: UncategorizedCleanup/optimization

I found that usage on this page. Is that what you were referring to?

comment:2 Changed 3 years ago by buyittoday@…

Yes. You will note in the here - https://docs.djangoproject.com/en/1.6/ that the built-in class based views are referred to as "built-in" but in the actual page referenced they are referred to as Class-based generic views.

Class-based views: Overview | Built-in display views | Built-in editing views | Using mixins | API reference | Flattened index
https://docs.djangoproject.com/en/1.6/

Note here they are referred to differently as Generic display views
https://docs.djangoproject.com/en/1.6/ref/class-based-views/

I believe that removing any ambiguity of terms will help the understanding and increase use of class based views where appropriate.

It would help if the documentation made a clear distinction between the implementation of class based views and the use of (ready made) "built-in class based views". The implementation of class based views generally involving a user defined class view inheriting from django.views.generic.base.View and mix-ins as needed to generate the appropriate view. The use of "built-in class based views" generally meaning to use ready made views based on the implementation class based views.

Changed 2 years ago by Tim Graham

Attachment: 22154.diff added

comment:3 Changed 2 years ago by Tim Graham

Has patch: set

Attached is a patch that renames two sections. Any other changes you would make?

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

Resolution: fixed
Status: newclosed

In 0c9f40f776e2be75656996e1bb1e5f37f903675f:

Fixed #22154 -- Added "Built-in" to some class-based views titles.

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

In da2077ed678de4b4b00821c99c5b912b8890066b:

[1.7.x] Fixed #22154 -- Added "Built-in" to some class-based views titles.

Backport of 0c9f40f776 from master

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

In 9bc10919809007fada06c0dc4bc5285f80e2e965:

[1.6.x] Fixed #22154 -- Added "Built-in" to some class-based views titles.

Backport of 0c9f40f776 from master

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