[Django] #22796: "Working with forms" docs need improving

13 views
Skip to first unread message

Django

unread,
Jun 8, 2014, 3:00:43 PM6/8/14
to django-...@googlegroups.com
#22796: "Working with forms" docs need improving
------------------------------------------------+------------------------
Reporter: EvilDMP | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: master
Severity: Normal | Keywords:
Triage Stage: Unreviewed | Has patch: 0
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 0
UI/UX: 0 |
------------------------------------------------+------------------------
Our main "introduction to forms" documentation is
https://docs.djangoproject.com/en/dev/topics/forms/

It lacks sufficient basic explanation of web form handling in general to
be useful to someone who is tackling this for the first time.

It also contains some sections that mention, but offer no explanation of,
matters that don't need to be in an introductory document.

It also interrupts its own basic explanations with unnecessary reference
to much more advanced concepts.

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

Django

unread,
Jun 8, 2014, 3:06:53 PM6/8/14
to django-...@googlegroups.com
#22796: "Working with forms" docs need improving
-------------------------------------+-------------------------------------
Reporter: EvilDMP | Owner: nobody
Type: | Status: new
Cleanup/optimization | Version: master
Component: Documentation | Resolution:
Severity: Normal | Triage Stage:
Keywords: | Unreviewed

Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------

Comment (by EvilDMP):

Patch in https://github.com/django/django/pull/2776.

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

Django

unread,
Jun 10, 2014, 8:30:05 AM6/10/14
to django-...@googlegroups.com
#22796: "Working with forms" docs need improving
-------------------------------------+-------------------------------------
Reporter: EvilDMP | Owner: nobody

Type: | Status: new
Cleanup/optimization | Version: master
Component: Documentation | Resolution:
Severity: Normal | Triage Stage: Ready for
Keywords: | checkin
Has patch: 1 | Needs documentation: 0

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

* has_patch: 0 => 1
* stage: Unreviewed => Ready for checkin


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

Django

unread,
Jun 14, 2014, 6:16:44 AM6/14/14
to django-...@googlegroups.com
#22796: "Working with forms" docs need improving
-------------------------------------+-------------------------------------
Reporter: EvilDMP | Owner: EvilDMP
Type: | Status: assigned

Cleanup/optimization | Version: master
Component: Documentation | Resolution:
Severity: Normal | Triage Stage: Ready for
Keywords: | checkin
Has patch: 1 | Needs documentation: 0

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

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


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

Django

unread,
Jun 19, 2014, 2:57:10 PM6/19/14
to django-...@googlegroups.com
#22796: "Working with forms" docs need improving
--------------------------------------+------------------------------------
Reporter: EvilDMP | Owner: EvilDMP
Type: Cleanup/optimization | Status: assigned
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 1

Easy pickings: 0 | UI/UX: 0
--------------------------------------+------------------------------------
Changes (by timo):

* needs_better_patch: 0 => 1
* stage: Ready for checkin => Accepted


Comment:

Some more comments have been left on the PR.

--
Ticket URL: <https://code.djangoproject.com/ticket/22796#comment:4>

Django

unread,
Jun 24, 2014, 2:59:45 PM6/24/14
to django-...@googlegroups.com
#22796: "Working with forms" docs need improving
--------------------------------------+------------------------------------
Reporter: EvilDMP | Owner: EvilDMP
Type: Cleanup/optimization | Status: closed
Component: Documentation | Version: master
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 1

Easy pickings: 0 | UI/UX: 0
--------------------------------------+------------------------------------
Changes (by Tim Graham <timograham@…>):

* status: assigned => closed
* resolution: => fixed


Comment:

In [changeset:"60375eda324d708870dc2ba18b4ac4d6114a68f6"]:
{{{
#!CommitTicketReference repository=""
revision="60375eda324d708870dc2ba18b4ac4d6114a68f6"
[1.7.x] Fixed #22796 -- Added a more basic explanations of forms.

Thanks bmispelon, kezabelle, jorgecarleitao, and timgraham for reviews.

Backport of cd20b5d186 from master
}}}

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

Reply all
Reply to author
Forward
0 new messages