[Django] #21938: Improve docs/ref/views.txt
Django
------------------------------------------------+------------------------
Reporter: timo | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: 1.6
Severity: Normal | Keywords:
Triage Stage: Accepted | Has patch: 0
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 1
UI/UX: 0 |
------------------------------------------------+------------------------
As noted in [https://github.com/django/django/pull/2231 this PR], the
"Built-in views" page isn't very useful. We should expand this page into a
proper reference guide for the functions in `django.views`, probably
moving some content from `topics/http/views.txt`.
--
Ticket URL: <https://code.djangoproject.com/ticket/21938>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
Django
--------------------------------------+------------------------------------
Reporter: timo | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: 1.6
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
Comment (by oswalpalash@…):
I totally Agree to your point. For new users view's functions need to be
defined more practically for usage. I'm a newbie here, but I'd like to
contribute to this fix. I'd be glad to help out and write the
documentation part.
--
Ticket URL: <https://code.djangoproject.com/ticket/21938#comment:1>
Django
--------------------------------------+------------------------------------
Reporter: timo | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: 1.6
Keywords: afraid-to-commit | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
Changes (by EvilDMP):
* keywords: => afraid-to-commit
Comment:
Ear-marked as suitable for a first-time committer at DjangoCon Europe
2014.
--
Ticket URL: <https://code.djangoproject.com/ticket/21938#comment:2>
Django
--------------------------------------+------------------------------------
Reporter: timo | Owner: JLinden
Type: Cleanup/optimization | Status: assigned
Component: Documentation | Version: 1.6
Severity: Normal | Resolution:
Keywords: afraid-to-commit | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
Changes (by JLinden):
* status: new => assigned
* owner: nobody => JLinden
--
Ticket URL: <https://code.djangoproject.com/ticket/21938#comment:3>
Django
--------------------------------------+------------------------------------
Reporter: timo | Owner: JLinden
Type: Cleanup/optimization | Status: assigned
Severity: Normal | Resolution:
Keywords: afraid-to-commit | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
Comment (by JLinden):
The error views are currently ordered by most commonly used, should we
keep it that way or order them by status code instead? As in 400, 403,
404, 500.
--
Ticket URL: <https://code.djangoproject.com/ticket/21938#comment:4>
Django
--------------------------------------+------------------------------------
Reporter: timo | Owner: JLinden
Type: Cleanup/optimization | Status: assigned
Severity: Normal | Resolution:
Keywords: afraid-to-commit | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
Comment (by timo):
I think the current order is okay, but I don't feel strongly about it. We
are likely to replace them with something more generic anyway (see
#22058).
--
Ticket URL: <https://code.djangoproject.com/ticket/21938#comment:5>
Django
--------------------------------------+------------------------------------
Reporter: timo | Owner: JLinden
Type: Cleanup/optimization | Status: assigned
Severity: Normal | Resolution:
Keywords: afraid-to-commit | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
Comment (by JLinden):
Ok, the order stays as it is.
I've sent a PR with my changes at
[https://github.com/django/django/pull/2710]
--
Ticket URL: <https://code.djangoproject.com/ticket/21938#comment:6>
Django
--------------------------------------+------------------------------------
Reporter: timo | Owner: JLinden
Component: Documentation | Version: 1.6
Severity: Normal | Resolution: fixed
Keywords: afraid-to-commit | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
Changes (by Tim Graham <timograham@…>):
* status: assigned => closed
* resolution: => fixed
Comment:
In [changeset:"5b98ba08e2cc8760525fc1e0a2c917c063b0d5e2"]:
{{{
#!CommitTicketReference repository=""
revision="5b98ba08e2cc8760525fc1e0a2c917c063b0d5e2"
Fixed #21938 -- Moved documentation for error views to reference guide.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/21938#comment:7>
Django
--------------------------------------+------------------------------------
Reporter: timo | Owner: JLinden
Type: Cleanup/optimization | Status: closed
Severity: Normal | Resolution: fixed
Keywords: afraid-to-commit | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
Comment (by Tim Graham <timograham@…>):
In [changeset:"a83c56a45a976375ffe1bdf014b0f1c38a610ee6"]:
{{{
#!CommitTicketReference repository=""
revision="a83c56a45a976375ffe1bdf014b0f1c38a610ee6"
[1.7.x] Fixed #21938 -- Moved documentation for error views to reference
guide.
Backport of 5b98ba08e2cc8760525fc1e0a2c917c063b0d5e2 from master
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/21938#comment:8>