[Django] #28802: PasswordResetForm has method send_email in the documentation but send_mail is the correct method

8 views
Skip to first unread message

Django

unread,
Nov 16, 2017, 10:14:48 AM11/16/17
to django-...@googlegroups.com
#28802: PasswordResetForm has method send_email in the documentation but send_mail
is the correct method
------------------------------------------+------------------------
Reporter: daniel-clayton | Owner: nobody
Type: Bug | Status: new
Component: contrib.auth | Version: 1.11
Severity: Normal | Keywords:
Triage Stage: Unreviewed | Has patch: 0
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 1
UI/UX: 0 |
------------------------------------------+------------------------
The documentation for PasswordResetForm has a typo.
[https://docs.djangoproject.com/en/1.11/topics/auth/default/#django.contrib.auth.forms.PasswordResetForm]
It lists
{{{
send_email(subject_template_name, email_template_name, context,
from_email, to_email, html_email_template_name=None)
}}}
as a method, the correct method name is:
{{{
send_mail(subject_template_name, email_template_name, context, from_email,
to_email, html_email_template_name=None)
}}}
as seen here
[https://github.com/django/django/blob/master/django/contrib/auth/forms.py#L246]

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

Django

unread,
Nov 16, 2017, 10:39:13 AM11/16/17
to django-...@googlegroups.com
#28802: PasswordResetForm has method send_email in the documentation but send_mail
is the correct method
--------------------------------+--------------------------------------
Reporter: Daniel Clayton | Owner: nobody
Type: Bug | Status: closed
Component: contrib.auth | Version: 1.11
Severity: Normal | Resolution: fixed

Keywords: | Triage Stage: Unreviewed
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: new => closed
* resolution: => fixed


Comment:

In [changeset:"d392fc293c9439c19451e152f9560f24d1659563" d392fc29]:
{{{
#!CommitTicketReference repository=""
revision="d392fc293c9439c19451e152f9560f24d1659563"
Fixed #28802 -- Fixed typo in docs/topics/auth/default.txt.
}}}

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

Django

unread,
Nov 16, 2017, 10:39:13 AM11/16/17
to django-...@googlegroups.com
#28802: PasswordResetForm has method send_email in the documentation but send_mail
is the correct method
--------------------------------+--------------------------------------
Reporter: Daniel Clayton | Owner: nobody
Type: Bug | Status: closed
Component: contrib.auth | Version: 1.11
Severity: Normal | Resolution: fixed

Keywords: | Triage Stage: Unreviewed
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:"2b3907cf74b7d4c15e50661c659f6b5ec7cb2f8d" 2b3907cf]:
{{{
#!CommitTicketReference repository=""
revision="2b3907cf74b7d4c15e50661c659f6b5ec7cb2f8d"
[2.0.x] Fixed #28802 -- Fixed typo in docs/topics/auth/default.txt.

Backport of d392fc293c9439c19451e152f9560f24d1659563 from master
}}}

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

Django

unread,
Nov 16, 2017, 10:39:23 AM11/16/17
to django-...@googlegroups.com
#28802: PasswordResetForm has method send_email in the documentation but send_mail
is the correct method
--------------------------------+--------------------------------------
Reporter: Daniel Clayton | Owner: nobody
Type: Bug | Status: closed
Component: contrib.auth | Version: 1.11
Severity: Normal | Resolution: fixed

Keywords: | Triage Stage: Unreviewed
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:"18324f2e657c68947e110f96a1a529e1e6c3f55e" 18324f2]:
{{{
#!CommitTicketReference repository=""
revision="18324f2e657c68947e110f96a1a529e1e6c3f55e"
[1.11.x] Fixed #28802 -- Fixed typo in docs/topics/auth/default.txt.

Backport of d392fc293c9439c19451e152f9560f24d1659563 from master
}}}

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

Django

unread,
Nov 16, 2017, 10:40:00 AM11/16/17
to django-...@googlegroups.com
#28802: PasswordResetForm has method send_email in the documentation but send_mail
is the correct method
--------------------------------+--------------------------------------
Reporter: Daniel Clayton | Owner: nobody
Type: Bug | Status: closed
Component: contrib.auth | Version: 1.11
Severity: Normal | Resolution: fixed

Keywords: | Triage Stage: Unreviewed
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:"1738592bd05d2526724ded69346d8548197ae49d" 1738592]:
{{{
#!CommitTicketReference repository=""
revision="1738592bd05d2526724ded69346d8548197ae49d"
[1.10.x] Fixed #28802 -- Fixed typo in docs/topics/auth/default.txt.

Backport of d392fc293c9439c19451e152f9560f24d1659563 from master
}}}

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

Django

unread,
Nov 16, 2017, 10:40:23 AM11/16/17
to django-...@googlegroups.com
#28802: PasswordResetForm has method send_email in the documentation but send_mail
is the correct method
--------------------------------+--------------------------------------
Reporter: Daniel Clayton | Owner: nobody
Type: Bug | Status: closed
Component: contrib.auth | Version: 1.11
Severity: Normal | Resolution: fixed

Keywords: | Triage Stage: Unreviewed
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:"97dfc30f5b97536fff0bc3cb2c9e34d0edf26f19" 97dfc30f]:
{{{
#!CommitTicketReference repository=""
revision="97dfc30f5b97536fff0bc3cb2c9e34d0edf26f19"
[1.8.x] Fixed #28802 -- Fixed typo in docs/topics/auth/default.txt.

Backport of d392fc293c9439c19451e152f9560f24d1659563 from master
}}}

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

Reply all
Reply to author
Forward
0 new messages