Code

Opened 7 years ago

Closed 7 years ago

#5870 closed (fixed)

send-mail docs out of date

Reported by: Carl Karsten <carl@…> Owned by: nobody
Component: Documentation Version: master
Severity: Keywords: deprecated email
Cc: Triage Stage: Unreviewed
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: UI/UX:

Description

help( send_mail )

Help on function send_mail in module django.core.mail:
    NOTE: This method is deprecated. It exists for backwards compatibility.
    New code should use the EmailMessage class directly.

This should be stated in
http://www.djangoproject.com/documentation/email/#send-mail

Attachments (0)

Change History (3)

comment:1 Changed 7 years ago by Carl Karsten <carl@…>

  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset

same page:

http://www.djangoproject.com/documentation/email/#the-emailmessage-and-smtpconnection-classes

.send() doesn't have it's interface documented.

def send(self, fail_silently=False):

from IRC jodal: CarlFK: yes, looks like the docs are lacking compared to the source.

Guessing the whole thing should be reviewed.

comment:2 Changed 7 years ago by mtredinnick

The first one is borderline. There's a difference between deprecated for internal Django use and deprecated as part of the external API (which is what is documented in the text). Anybody reading the docstring is quite free not to use send_mail(), but I'm not sure it's worth asking everybody to port away from it in public code yet.

For the second one, we take patches.

comment:3 Changed 7 years ago by ubernostrum

  • Resolution set to fixed
  • Status changed from new to closed

(In [6790]) Fixed #5870: documented the "fail_silently" argument to EmailMessage.send().

Add Comment

Modify Ticket

Change Properties
<Author field>
Action
as closed
as The resolution will be set. Next status will be 'closed'
The resolution will be deleted. Next status will be 'new'
Author


E-mail address and user name can be saved in the Preferences.

 
Note: See TracTickets for help on using tickets.