[Django] #23106: Rename API reference page "Class-based views" to "Class-based views API reference"

12 views
Skip to first unread message

Django

unread,
Jul 26, 2014, 10:27:46 AM7/26/14
to django-...@googlegroups.com
#23106: Rename API reference page "Class-based views" to "Class-based views API
reference"
--------------------------------------+--------------------
Reporter: jarus | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: 1.6
Severity: Normal | Keywords:
Triage Stage: Unreviewed | Has patch: 0
Easy pickings: 0 | UI/UX: 1
--------------------------------------+--------------------
Currently there are two pages called "Class-based views".

[https://docs.djangoproject.com/en/1.7/topics/class-based-views/ Topic
page]
[https://docs.djangoproject.com/en/1.7/ref/class-based-views/ API
reference]

Also a google search for "django class-based views" is very confusing.
[[Image(https://files.thelabmill.de/shuttle/Screen%20Shot%202014-07-26%20at%2016.18.12-GLZOcWCUbs.png)]]

I would propose to rename the API page into "Class-based views API
reference". A possible problem is that the version choicer isn't able
anymore to switch through the version in the API reference overview page.


See also #17638.

--
Ticket URL: <https://code.djangoproject.com/ticket/23106>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

Django

unread,
Jul 26, 2014, 10:38:27 AM7/26/14
to django-...@googlegroups.com
#23106: Rename API reference page "Class-based views" to "Class-based views API
reference"
--------------------------------------+------------------------------------

Reporter: jarus | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: 1.6
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 1
--------------------------------------+------------------------------------
Changes (by timo):

* needs_better_patch: => 0
* needs_docs: => 0
* needs_tests: => 0
* easy: 0 => 1
* stage: Unreviewed => Accepted


Comment:

I would call it "Class-based views API" for consistency with others pages
like "The Forms API" and since it's a bit shorter without losing clarity.

--
Ticket URL: <https://code.djangoproject.com/ticket/23106#comment:1>

Django

unread,
Jul 26, 2014, 11:50:12 AM7/26/14
to django-...@googlegroups.com
#23106: Rename API reference page "Class-based views" to "Class-based views API
reference"
--------------------------------------+------------------------------------
Reporter: jarus | Owner: dhoffman
Type: Cleanup/optimization | Status: assigned
Component: Documentation | Version: 1.6

Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 1
--------------------------------------+------------------------------------
Changes (by dhoffman):

* owner: nobody => dhoffman
* status: new => assigned


--
Ticket URL: <https://code.djangoproject.com/ticket/23106#comment:2>

Django

unread,
Jul 26, 2014, 2:54:49 PM7/26/14
to django-...@googlegroups.com
#23106: Rename API reference page "Class-based views" to "Class-based views API
reference"
--------------------------------------+------------------------------------
Reporter: jarus | Owner: dhoffman
Type: Cleanup/optimization | Status: assigned
Component: Documentation | Version: 1.6

Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 1
--------------------------------------+------------------------------------
Changes (by dhoffman):

* has_patch: 0 => 1


Comment:

Fixed: https://github.com/django/django/pull/2980

--
Ticket URL: <https://code.djangoproject.com/ticket/23106#comment:3>

Django

unread,
Jul 26, 2014, 8:47:45 PM7/26/14
to django-...@googlegroups.com
#23106: Rename API reference page "Class-based views" to "Class-based views API
reference"
--------------------------------------+------------------------------------
Reporter: jarus | Owner: dhoffman
Type: Cleanup/optimization | Status: closed
Component: Documentation | Version: 1.6
Severity: Normal | Resolution: fixed

Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 1
--------------------------------------+------------------------------------

Comment (by Tim Graham <timograham@…>):

In [changeset:"30ccb36cb9c1bc9bd30edb2b67f26ef2a1e4fb53"]:
{{{
#!CommitTicketReference repository=""
revision="30ccb36cb9c1bc9bd30edb2b67f26ef2a1e4fb53"
[1.7.x] Fixed #23106 -- Updated class-based view reference title.

Backport of f14898a453 from master
}}}

--
Ticket URL: <https://code.djangoproject.com/ticket/23106#comment:5>

Reply all
Reply to author
Forward
0 new messages